如何生成多个手册页?

时间:2012-07-06 10:52:13

标签: python python-sphinx man

我有一个用Python编写的命令行程序。我想用Sphinx生成手册页。

我希望通过以下命令创建一个页面:

man myprog foo - >重定向到foo命令的手册页。

man myprog foo2 - >重定向到foo2命令的手册页。

问题是Sphinx只生成一个手册页,其中包含所有手册页的聚合。

我如何获得预期的结果?

1 个答案:

答案 0 :(得分:0)

鉴于结构

    docs/
    docs/source
    docs/source/conf.py
    docs/source/manable1/includable.rst
    docs/source/index.rst

然后,如果你在docs中输入

    sphinx-build -b man -c source  source/manable1/ man/other_man

你可以通过修补makefile或bash中的单行来自动化

    for i in source/man*; do
            sphinx-build -b man -c source  $i man/$( basename $i );
    done

(未经测试但应该关闭)

要注意包含路径,亲戚,交叉引用......

它可能限制你在Rst中可以做的事情