Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Generator for any Code #25

Open
vshesh opened this issue Dec 18, 2016 · 2 comments
Open

Documentation Generator for any Code #25

vshesh opened this issue Dec 18, 2016 · 2 comments

Comments

@vshesh
Copy link
Owner

vshesh commented Dec 18, 2016

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.

@vshesh
Copy link
Owner Author

vshesh commented Mar 23, 2017

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 .

@vshesh vshesh added the docmebro label Apr 2, 2017
@vshesh
Copy link
Owner Author

vshesh commented Apr 2, 2017

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant