自动分类和实例属性
根据 sphinx文档， .. autoattribute 指令应该能够记录实例属性。但是，如果我这样做了：: .. currentmodule :: xml.etree.ElementTree 。 。autoclass :: ElementTree .. autoattribute :: ElementTree._root 然后在构建时出现Attribut
..
autodoc相关内容
覆盖Sphinx autodoc的“别名”私人课的进口？
我有一个Python软件包，正在尝试使用sphinx-autodoc进行文档记录。我的python软件包有一个 __ init __。py 文件，该文件从子模块中导入一个类，以使其在软件包级别可访问。 从abcd导入_Foo作为Foo __all__ = [“ Foo”] 如果这样做，我的（html）文档如下： abc包 子模块
..
使用sphinx autodoc生成fabfile
是否可以使用Sphinx autodoc通过函数docstrings为我的fabfile生成文档？ 例如。对于我尝试过的包含 setup_development 任务的fabfile： 。 。automodule :: fabfile ：成员： .. autofunction :: setup_development 但是什么也没生成。 fabfile
..
在Sphinx中，如何包括位于模块中但类和方法之外的文档字符串/注释
我的包裹中有一个 utils 模块。它由几个不需要实例化的杂项独立方法组成。 我想在此 utils 文件，例如： import os import json “ “” 可以帮助> 的其他方法不需要显式实例化。 可以执行以下操作： = ============================ 操作方法 =========== ====
..
如何在python docstring中指定不同的返回类型
我目前正在使用Sphinx和autodoc插件编写有关python软件包的文档。 对于函数返回值我可以例如编写：returns：int：count 告诉sphinx，有一个int类型的返回值，名为count。 我现在有了一个使我数据库中的项目前身的函数： def get_previous_release（release_id）： “”“ HoltVorgängeritemeine
..
在狮身人面像中包含特定的特殊方法
我有一堆使用“特殊方法”的类： class Foo（object）： “ Foo docstring” attr1 =“属性！” ＃：第一个属性 attr2 =“另一个属性！” ＃：第二个属性 def __init __（self）： self.x = 12 def say_hello（self）： “”“ say_hello（self）->无 发出友好的
..
Swagger-PHP，用于为Swagger-UI生成JSON文件
我正在尝试使用Swagger-PHP生成JSON文件，以便可以将其与Swagger-UI一起用于自动文档编制。 我尝试了以下链接： - https://github.com/zircote/swagger-php 我也尝试使用 http：// zircote上的文档.com / swagger-php / installation.html 但是我很不幸，我无法实现它。 我
..
得到“扁平”的狮身人面像自动模块的成员输出
我正在使用Sphinx autodoc扩展来对模块进行文档记录，我想在文档输出中获得模块成员的 flat 列表。 我尝试使用以下命令： .. automodule :: modname ：members： 但是，这有两个问题： 它包括模块的文档字符串，我在这里不需要。 每个条目的名称都以“ modname。”为前缀，这是完全多余的（因
..
在Sphinx文档中包含docstring
我想在我的Sphinx文档中仅包含特定函数的文档字符串。但是，似乎没有选项可以仅显示这些详细信息，而无需使用 http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html 尝试按照在Sphinx文档中仅显示* docstring概述的方式创建类。但我不确定这与模板是否相符。 我也尝试过autodoc-process-
..
使用Sphinx自动记录python类，模块
我已经安装了 Sphinx ，以便记录一些我正在使用的Python模块和类。虽然标记语言看起来非常不错，但我还没有设法自动记录Python代码。 基本上，我有以下Python模块： SegLib.py 其中有一个名为 Seg 的类。我想在生成的Sphinx文档中显示类和模块的文档字符串，并向其中添加更多格式化的文本。 我的索引。 rst 看起来像这样：
..
在Sphinx文档中显示* only *文档字符串？
Sphinx具有一项称为 automethod 的功能，该功能可从方法的文档字符串中提取文档并将其嵌入到文档中。但是它不仅嵌入了文档字符串，而且还嵌入了方法签名（名称和参数）。如何仅在文档字符串中嵌入 （不包括方法签名）？ ref： http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html 解决方案 我认为您正
..
autodoc和明确指定的实例属性存在问题
我编写了一个python类，并使用sphinx编写了文档。例如，该类如下所示： class Aclass（object）： “”“我的类”“” def __init __（self）： “”“构造函数”“” self.a =无 “”“属性a为“ “” self._prop =无 def _get_prop（self）： “”“吸气剂道具”“” 返回self.
..
Python Sphinx排除模式
我正在使用Sphinx为具有以下结构的项目生成文档： +项目 | +-文档 | +-测试 | +-工作流程-+-定义-+- | +- 我想从文档中排除测试和工作流程/定义。 我尝试在docs / conf.py中排除模式 exclude_patterns = ['** / workflow /
..
如何使用autodoc覆盖Sphinx中的构造函数参数？
比方说我有一个这样的类： class MyClass（object）： “”“摘要我班的文档。 我班的扩展文档。 “”“ def __init __（self，* args）： self.values = np.asarray（args） 如果我将Sphinx与 autodoc 扩展来记录此类，如下所示： .. automodule :: mymod
..
未知的指令类型“ toctree”。 Pycharm中的错误，但是index.html可以工作
在PyCharm中工作时，我正在Sphinx中创建的文档的预览模式显示： 系统消息：错误/ 3（
..
从sphinx autodoc发出reStructuredText吗？
CPython的文档不使用autodoc，而是使用手写散文。 对于PEP 3144（ipaddress模块），我想使用sphinx-apidoc生成初始参考文档。这意味着我要运行两遍操作： 使用sphinx-apidoc为该模块发出Sphinx项目取决于autodoc 运行一个狮身人面像生成器，该创建新的reStructuredText源文件，所有autodoc指令都替换为内
..
Sphinx的autodoc的automodule显然无效
我正在包含 automodule 的 rst 文件上运行Sphinx，但似乎没有任何效果。 / p> 以下是详细信息：我有一个Python项目，文件 agent.py 包含类 Agent 。我还有一个子目录 apidoc ，其中有文件 agent.rst （由 sphinx生成） -apidoc ）： 代理模块 ========= === .. automodule :: a
..
在autodoc中排除模块docstring
我正在尝试在Sphinx中使用autodoc打印出特定模块中每个函数的文档字符串，但不包括该模块的文档字符串。 原因是我正在使用模块docstring指定命令行选项（带有可爱的docopt）。 解决方案 将以下内容添加到 conf.py ： def remove_module_docstring（app，what，名称，obj，选项，行）： if what ==“ modu
..
如何使用Python-Sphinx生成HTML文档？
我正在使用PyCharm进行Python项目，现在我需要生成相应的API文档。我正在使用 docstrings 记录代码方法和类。我读到了有关狮身人面像和Doxygen的信息，现在最推荐使用狮身人面像。我尝试配置Sphinx whitin PyCharm，但我没有运气。 这是项目结构： 这是与命令 Sphinx的I / O交互快速入门 C：\Python\Python36\Sc
..
Sphinx autodoc不够自动化
我正在尝试使用Sphinx在Python中记录5,000多个项目。它有大约7个基本模块。据我所知，为了使用自动文档，我需要为项目中的每个文件编写如下代码： 。 。automodule :: mods.set.tests ：成员： ：显示继承性： 这太麻烦了，因为我有很多文件。如果我只想指定要记录的“ mods”包，那就容易多了。然后，Sphinx可以递归地浏览该软件包，并为
..