speedoc 0.2

安装

python -mpip install git+https://github.com/anntzer/speedoc

可以使用pytest运行测试。

用法

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

(With numpydoc≥0.9, it is not necessary anymore to explicitly load autodoc.)

可以通过设置（标准）MANOPT环境变量来传递man选项。例如，可以使用以下方式禁用对齐

MANOPT=--nj speedoc ...

故障排除

Q:

文档字符串渲染得很糟糕！

A:

无效的RST格式化很常见 :-(