如何将：特殊成员：仅应用于自动模块指令中的一个类？
我正在使用autodoc和napoleon为一个Python2.7项目整理Sphinx驱动的(v1.3.1)文档。在我想用单个automodule::指令记录的一个模块中，我有一个要应用:special-members:标志的特定类。将automodule::标记为:special-members:会显示模块中所有的特价商品，这不太好。 如何执行此操作？ 添加标记为:special-m
..
sphinx-napoleon相关内容
Sphinx自动文档-跳过成员处理程序：使用拿破仑时不能显示__init__()
我希望将__init__()的文档字符串包括在我的Shinx生成的文档中。 我正在跟随the accepted answer to this stackoverflow question为autodoc-skip-member添加处理程序，但仍然无法查看我的__init__()文档。if name == "__init__":块中的跟踪代码显示我正在访问该代码。 凭直觉，我从exten
..
Python代码中注释和文档字符串的基本语法
我正在学习如何使用Sphinx为我的代码创建文档。在我看到一些这样的例子后： def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part
..
Sphinx拿破仑可以记录返回多个参数的函数吗？
我正在尝试使用Google代码样式来记录一个函数，然后我使用带有拿破仑扩展的Shinx来为其创建文档。该函数的不同寻常之处在于它返回两个参数。我不认为拿破仑会处理这件事。如果是这样的话，谁能告诉我他们是怎么处理的？ def foo(a): '''one line summary longer explanation Args: a (int): parameter descripti
..
拿破仑和奥多克如何互动记录成员
我注意到Sphinx呈现类描述的行为发生了变化。给定此代码 # my example happens to be a dataclass, but the behavior for # regular classes is the same @dataclass class TestClass: """This is a test class for dataclasses.
..
如何在Sphinx处理的文档字符串中表示单个参数或返回值的多个类型？
有时，Python中的函数可能会接受灵活类型的参数。或者，它可以返回灵活类型的值。现在我记不起这样一个函数的好例子了，所以我在下面用一个玩具例子演示这样的函数可能是什么样子。 我想知道如何使用Sphinx文档表示法为这些函数编写文档字符串。在下面的示例中，参数可以是str或int。同样，它可能返回str或int。 我给出了一个文档字符串示例(既使用默认的Sphinx表示法，也使用Sph
..
Sphinx 自动摘要“toctree 包含对不存在的文档的引用"警告
我正在尝试使用 Sphinx 为大型 Python 代码库自动创建 api 文档. 我尝试过使用 build_modules.py 和 sphinx-apidoc.使用任何一个，我都可以在我的输出目录中为包和顶级模块成功创建 rst 文档. 但是，当我构建使用 制作html 它给出了数千个这种类型的错误: :None: WARNING: toctree 包含对不存在的文档“rst
..
我应该记录类似函数签名的参数吗?
我有一些辅助函数，除了第一个参数外，它们采用与核心函数相同的参数.参数在核心函数中进行了详细记录.我是否也应该将此文档复制粘贴到辅助函数中，或者只是指向核心文档? 这很重要，我主要希望我的 API 参考被读取为 Sphinx 生成的 HTML，并且我使用 numpydoc 样式.我在 numpydoc 手册中没有找到答案. 编辑 这是一个 MWE: def core(param
..
如何在Sphinx文档中自动添加参数类型
我目前正在尝试使用Sphinx实现自动文档创建(使用扩展名sphinx-apidoc和napoleon).这样效果很好，但是如果将typehints(PEP484约定)自动添加到params列表中，那就更好了. 我想知道这是否可能. 更具体地说:(摘自拿破仑示例 ) def function_with_pep484_type_annotations(param1: int, pa
..
强制Sphinx用Python文档字符串而不是reStructuredText解释Markdown
我正在使用Sphinx记录python项目.我想在我的文档字符串中使用Markdown格式化它们. 即使我使用recommonmark扩展名，它也仅涵盖手动编写的.md文件，而不包括文档字符串. 我在扩展程序中使用autodoc，napoleon和recommonmark. 如何在我的文档字符串中使狮身人面像解析降价? 解决方案 Sphinx的autodoc扩展名发出名为我不知
..