You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Convert python code to glue syntax then spit out docs. Easy to do - switch comments to non-comments and wrap uncommented sections in ---code python\n[CODE HERE]\n... and spit it back out. Could be a cool application of glue - it basically turns your code into a research paper that looks very fancy and all. You can include math, and many other rich elements besides.
Bonus points if I can copy LaTeX's look and feel, ignoring the code blocks.
The text was updated successfully, but these errors were encountered:
Even better would be to use the annotated code component since that would hide a lot of ugly comments in the middle of the code.
Another possible enhancement is to convert a glue document into code. This may not be a good idea since writing code requires being inside of an IDE so that you can have all the nice syntax checking and error reporting. It would be pretty cumbersome to write all the documentation and then have to keep modifying/recompiling/reloading in the browser again and again .
There are libraries like sphinx and especially pdoc which can do the heavy lifting of converting the docs into something nice and browsable. The only thing left is rendering all the static glue blocks to inline HTML that will be picked up by their markdown parsers and making sure the header files get included properly.
Convert python code to glue syntax then spit out docs. Easy to do - switch comments to non-comments and wrap uncommented sections in
---code python\n[CODE HERE]\n...
and spit it back out. Could be a cool application of glue - it basically turns your code into a research paper that looks very fancy and all. You can include math, and many other rich elements besides.Bonus points if I can copy LaTeX's look and feel, ignoring the code blocks.
The text was updated successfully, but these errors were encountered: