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.

Sign up for GitHub

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

Jump to bottom

Generate api docs #39

Open

danyaljj opened this issue Apr 17, 2017 · 4 comments

Member

danyaljj commented Apr 17, 2017

Generate a standard-looking functional api.

danyaljj changed the title ~~Function api ?~~ Generate api docs

Member Author

danyaljj commented Apr 17, 2017

Here are a bunch of tools I thoughts were nice:

Seems to be the standard doc generator tool: http://www.sphinx-doc.org/en/stable/ext/autosummary.html
Beautiful docs: https://github.com/BurntSushi/pdoc
Example: http://pdoc.burntsushi.net/pdoc
Semi-beautiful results: https://github.com/BurntSushi/pdoc
https://www.carta.tech/man-pages/man1/pydoctor.1.html

Member Author

danyaljj commented Apr 19, 2017

anyone wants to take over this? @GHLgh @bhargav
otherwise I'll do it myself.

Member Author

danyaljj commented Apr 21, 2017

Sample docs generated: http://cogcomp.cs.illinois.edu/software/doc/sioux/
The generation is pretty simple:

Make sure the most recent version of sioux is installed.
And install pdoc: pip install pdoc
Generate the docs: pdoc --html sioux

Contributor

bhargav commented Apr 21, 2017

Added the API Document generation and deployment code to Jenkins. Will close the issue after testing a few times.

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