如何使用Sphinx

时间:2018-04-15 09:34:14

标签: python-sphinx

目前我这样做:

conf.py:

autosummary_generate = True

reference.rst:

package_1
---------
.. autosummary::
   :toctree: _generated

   package_1.module_1
   package_1.module_2
   package_1.module_3
   ...

这将为每个模块生成一个概述表,其中包含每个模块的条目 很好地链接到详细页面。

我有两个问题:

  1. 我真的必须枚举每一个模块吗?
  2. 如何控制详细信息页面的选项?
  3. 广告1: 我想这样做(目前不起作用):

    .. autosummary:: package_1
       :toctree: _generated
       :members:
    

    (或者可能是新的autopackage命令。)

    广告2: 我希望传递automoduleautoclass期望的选项,例如:

    .. autosummary::
       :toctree: _generated
       :undoc-members:
       :private-members:
    

    这似乎是一项显而易见的任务,所以我可能错过了一些信息。 有没有一种简单的替代方法来实现这一目标?

1 个答案:

答案 0 :(得分:0)

感谢所有评论者!

广告1:
我手动列出模块。

广告2:
我终于采用了this提出的解决方案和this类似问题的答案:

创建模板文件(_templates/autosummary/module.rst_templates/autosummary/class.rst)并将其添加到
api_doc.rst:

Package ``wsgidav``
-------------------
.. autosummary::
   :toctree: _autosummary

   wsgidav._version
   wsgidav.compat