斯芬克斯遇见了派多克。
speedoc的Python项目详细描述
使用Sphinx将docstring转换为手册页，并使用man查看结果。
用法
speedoc [--opts ...] obj.to.document
选项按原样传递给python -msphinx。默认情况下，sphinx是 调用为
# $tmpdir1, $tmpdir2 are set up by speedoc. # -bman: build a man page; -q: quietly python -msphinx $tmpdir1$tmpdir2 -bman -q -Dextensions=sphinx.ext.napoleon
用最小的conf.py设置man_pages = [("contents", obj_name, "\n", "", "3")]。使用numpydoc而不是sphinx.ext.napoleon， 呼叫
speedoc -Dextensions=sphinx.ext.autodoc,numpydoc obj.to.document
（当numpydoc≥0.9时，不再需要显式加载autodoc。）
通过设置（标准）^{tt7}，可以传递man的选项$ 环境变量。例如，可以使用
MANOPT=--nj speedoc ...
故障排除
| Q: | Docstrings are rendered terribly! |
|---|---|
| A: | Invalid RST formatting is very common :-( |
欢迎加入QQ群-->： 979659372
