cogcomp-nlpy icon indicating copy to clipboard operation
cogcomp-nlpy copied to clipboard
verified publisher icon CogComp

Generate api docs

Open danyaljj opened this issue 8 years ago • 4 comments

Generate a standard-looking functional api.

danyaljj avatar Apr 17 '17 19:04 danyaljj

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

danyaljj avatar Apr 17 '17 20:04 danyaljj

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

danyaljj avatar Apr 19 '17 15:04 danyaljj

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

danyaljj avatar Apr 21 '17 03:04 danyaljj

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

bhargav avatar Apr 21 '17 21:04 bhargav