Post

PySky, what is your favorite automated documentation tool? Investigating to round out the docs of an internal platform I'm working on, and want something a bit more detailed than just a docstring-generated list of methods and inputs. One thing I'd like is class diagrams of derived classes #python

6 reposts7 likes

I generally like pdoc3 for this purpose. It makes it easy to generate a GitHub Pages documentation site (private to my organization) from Python docstrings. I tend to write pretty detailed docstrings, though (e.g. not just args/raises/returns, but actual markdown docs) - YMMV. pdoc3.github.io/pdoc/

pdoc3.github.iopdoc – Auto-generate API documentation for Python projectsAuto-generate API documentation for Python projects from docstrings in numpydoc, Google, or plain Markdown format.

Hah fair! I haven’t used them much, and I don’t want to solely rely on them (I think how-tos and more targeted docs are best) but I’m hoping we can get at least a good reference guide out of them