sphinx-refdoc 0.3.1

关于

sphinx refdoc是sphinx的python参考文档生成器。

安装

$ pip install sphinx-refdoc

用法

$ sphinx-refdoc -i <src_pkg_1> -i <src_pkg_2> -o <out_dir>

sphinx-refdoc将解析作为第一个参数传递的源代码树。 然后，它将为该源的sphinx参考文档生成一个存根。 它自动生成所有必需的文件（每个模块一个）并创建导航 基于源代码的包结构。

然后将其保存到作为第二个参数传递的目录中。这个遗嘱 通常是sphinx文档目录的子目录。那你可以 通过指点容易地将生成的文档与现有文档一起包含 指向<；out_dir>；/索引。rst。假设您有以下目录 结构：

docs/
├── ref/
└── index.rst

其中docs/ref是包含生成的引用文档的目录 （调用sphinx-refdoc的第二个参数）和index.rst是 文档主索引文件（conf.py指向它）。如果你想的话 包括参考文档，只需将ref/index添加到 托特瑞。例如：

..toctree::

    my_topic_1
    my_topic_2
    docs/ref

贡献

设置开发回购

$ git clone git@github.com:novopl/sphinx-refdoc.git
$ cd sphinx-refdoc
$ virtualenv env
$ source ./env/bin/activate
$ pip install -r requirements.txt -r ops/devrequirements.txt