Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。
我刚开始使用狮身人面像并愿意学习。我想将我的各种功能分解为index.rst文件中的不同部分。因此，每个函数都有其自己的标头。所以...
假设我有一个这样的类：class MyClass（object）：“”“该类的摘要文档。该类的扩展文档。”“” def __init __（self，* args）：self.values = .. 。
在带有部分的Python模块中构建Sphinx autodoc文档
我正在尝试改善python模块的文档结构。现在，我有一个Sphinx index.rst文件，如下所示：目录：.. toctree ::：：maxdepth：3 .. automodule :: ... ... >>
我正在使用autodoc来记录一些类，到目前为止，：members :、：private-members：和：special-members：可以让我得到我想要的东西。但是，我也希望看到继承的成员。 ...
我正在使用Sphinx的自动文档功能来记录我的API。示例：DEFAULT_OPTION ='default'def do_something（msg，option = DEFAULT_OPTION）：print msg生成的文档现在显示...
我目前正在使用autodoc记录整个模块。但是，我在模块级别定义了几个包含长列表或字典的变量。它们与...
Numpy项目提供了有关其文档格式设置的规范，以支持可读性和自动提取（链接）。他们还提供了Numpydoc，作为Sphinx的扩展，...
我正在使用带有numpydoc扩展名和autosummary的sphinx。经过一些试验后，我在conf.py文件中添加了以下选项。 autosummary_generate = True numpydoc_show_class_members = ...
我正在编写Python API，并且已经使用Google docstring约定对源代码中的每个类和函数进行了文档记录，我发现它比Sphinx约定更具可读性。我想使用...
我是使用狮身人面像的新手。看起来不错。我几乎已经使用autodoc记录了我所有的项目，但是我想改变一种行为。在阅读文档时，我已经看到了以下内容：autodoc_member_order，...
Sphinx中是否有标准或最佳实践来为复合Python数据类型提供更准确的规范？例如，我有一个函数，该函数返回将str映射到str和am的dict…
-the-docs生成失败，并且“无法从'pip._internal.index'导入名称'PackageFinder'”]
在阅读文档上构建Sphinx文档失败，并显示以下错误（以下完整日志）：ImportError：无法从“ pip._internal.index”（/ home / docs / checkouts /导入名称“ PackageFinder”。 。
尽管阅读了本教程，这个问题和numpy docstring标准，但我无法使sphinx autodoc与numpy docstring完美搭配。在我的conf.py中，我有：extensions = ['sphinx.ext ....
在哪里可以找到有关带有狮身人面像-doc的拿破仑扩展的Google样式文档字符串中支持的新语法的更多信息？
此处的版本1.3.4的sphinx-doc napoleon Google样式docstrings示例显示，应将函数/方法的可选参数记录如下：param2（str，可选）：第二个...
我遇到一个问题，当我的python文件更新时，Sphinx无法更新html页面。我的docs文件夹看起来像这样：上面文件夹中的api.rst文件看起来像这样：API Documentation == ...
Sphinx：链接到Python文档字符串中另一个模块中类的方法
我想在一个模块（例如module_1.py）的另一个方法中添加到一个模块（例如module_2.py）中类的方法的链接。我希望链接在Sphinx中工作。假设：module_1.py类ABC：...
我想知道是否有一种方法可以将指令添加到带有隐藏部分的狮身人面像文档中，该部分可以通过单击打开。基本上像您可以找到https：//realpython.com/pandas -...