时间戳

首页 > 解决方案 > 避免水泥配置的不良 Sphinx 格式

python-sphinx - 避免水泥配置的不良 Sphinx 格式

问题描述

我们Sphinx用来格式化我们的 Python 文档，并cement配置我们的 CLI。不幸的是，从配置Sphinx中生成了很多无意义的输出。cement

我一直找不到任何 Sphinx 指令或命令行选项来忽略它不应该格式化的水泥配置。我们正在使用Sphinx 2.2.0, 和sphinx-apidocwith options -f -P -o。

例如，Sphinx 格式化这个 Python

class BaseController(cement.Controller):
    """ Base controller for command line application """

    class Meta:
        label = 'base'
        description = "Command line utilities for managing whole-cell model definitions"
        help = "Command line utilities for managing whole-cell model definitions"
        arguments = [
            (['-v', '--version'], dict(action='version', version=wc_lang.__version__)),
        ]

进入本文档

嘈杂的文档

文档不应显示Meta课程的内容。Python可以用Sphinx指令注释来完成这个吗？

标签： python-sphinxcement

解决方案

文档不应显示 Meta 类的内容。

我假设您有一个automodule看起来像这样的指令（由 sphinx-apidoc 生成）：

.. automodule:: wc_lang.__main__
   :members:
   :undoc-members:
   :show-inheritance:

嵌套Meta类不包含文档字符串，因此它被包含在:undoc-members:选项中。sphinx-apidoc默认添加此选项。

Meta要从文档中排除，请删除:undoc-members:. 另一种方法是添加:exclude-members: Meta.

推荐阅读