HN Explorer

Ask HN: How do people generate documentation from Python comments?

4 points by RPeres ↗ HN
We are in the process of improving our documentation for our users. I am not experienced at all in the Python ecosystem, so I would like to get some idea/suggestions on how people are generating docs from python comments. The idea is to then put the output on a website, so people can access publicly.

4 comments

[ 3.1 ms ] story [ 23.8 ms ] thread
jjgreen
It used to be that Sphinx [1] was the go-to solution, possibly something else has emerged since I was doing this sort of thing. Some example output at [2]

[1] https://www.sphinx-doc.org/en/master/

[2] http://soliton.vm.bytemark.co.uk/pub/docs/mvpoly/

StokoeKeagan
I'm in the process of setting up docs for a Python based CLI and Sphinx has continually come up as the best option. Ran through the setup today and it was straightforward, next step is figuring out how to auto-generate the docs from docstrings.