sphinx meets pydoc.
Turn docstrings into man pages using Sphinx, and view the result with man.
python -mpip install git+https://github.com/anntzer/speedoc
Tests can be run with pytest.
speedoc [--opts ...] obj.to.document
Options are passed as is to python -msphinx. By default, sphinx is invoked as
# $tmpdir1, $tmpdir2 are set up by speedoc. # -bman: build a man page; -q: quietly python -msphinx $tmpdir1 $tmpdir2 -bman -q -Dextensions=sphinx.ext.napoleon
speedoc -Dextensions=sphinx.ext.autodoc,numpydoc obj.to.document
(With numpydoc≥0.9, it is not necessary anymore to explicitly load autodoc.)
Options to man can be passed by setting the (standard) MANOPT environment variable. For example, justification can be disabled with
MANOPT=--nj speedoc ...
Docstrings are rendered terribly!
Invalid RST formatting is very common :-(
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.