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

Mkdocsmaterial + mkdocstrings. mkdocstrings.github.io

Leveraging type hints and Google style docstrings is where it stands out. It automatically does cross linking to other type hints and redness and markdown you have in your docstrings. So you can even have example usage in your docstrings with fenced code blocks. mkdocstrings.github.io/python/