Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Any tools to render side-by-side annotations from source code? #181

Answered by hnipun
miaotianyi asked this question in General
Discussion options

I'm wondering if there's an open source tool to generate a website like https://nn.labml.ai/ (side-by-side, line-by-line rendering of code and annotations) from source code directly. If so, what are some of the formats that the python comments should follow? Is there a service like readthedocs that can host websites like this?

You must be logged in to vote

If you want to try out https://lit.labml.ai, you'll find that its format is easy to follow.

As an example, take a look at https://github.com/vpj/rl_samples/blob/master/ppo.py which renders https://lit.labml.ai/github/vpj/rl_samples/blob/master/ppo.py.

Replies: 1 comment 3 replies

Comment options

If you want to try out https://lit.labml.ai, you'll find that its format is easy to follow.

As an example, take a look at https://github.com/vpj/rl_samples/blob/master/ppo.py which renders https://lit.labml.ai/github/vpj/rl_samples/blob/master/ppo.py.

You must be logged in to vote
3 replies
Comment options

Thanks! I attempted to alter the .py files, but this didn't result in any changes to the corresponding .html files.

It seems that modifications to the .html files are only recognized when they are made directly within the .html file itself.

But the code within the .html file is quite messy, making it difficult to work with. Additionally, I was unable to locate any explicit code to link to the .py files within the .html file.

Comment options

Any updates?

Comment options

https://lit.labml.ai/ is not available.

Answer selected by miaotianyi
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

AltStyle によって変換されたページ (->オリジナル) /