setter参数的类型未在狮身人面表文档中显示
我不知道如何使类型提示出现在seters参数的狮身人面像生成的文档中。 我有一个python类，带有一个名为批处理的属性，并且在属性中有Docstrings，并在s…
如何自定义狮身人面像中的python域？
我想自定义 Sphinx Python 域以识别方法文档字符串中的自定义字段并为其生成自定义 HTML。 例如，假设我想为模块中的每个方法添加一个类别。我希望能…
由于SYS.PATH，在制作HTML期间的错误
我正在尝试为包构建 Sphinx 文档，但我不断收到错误，需要一些帮助。我的项目目录是 bb_lite ，代码位于 backend 文件夹中。 bb_lite ├── 1.0\ doc…
如何在 sphinx 中将使用自动摘要创建的某些存根文件显示为目录中的副标题？
我在sphinx中使用 autosummary 来创建存根文件，并通过 index.rst 文件进行记录。我有一个模块文件夹，其中有一些Python文件。我希望这些python文件是…
Sphinx 无法将链接文本生成为文字
有了Markdown，我可以简单地： [`a link with monospace font`](https://www.example.com) 链接与Monospace Font 注意上一行如何由SO的MD渲染器正确渲…
Sphinx conf.py - 将附加文档特定数据传递给每个 PDF，例如文档标题和作者
我的目标是在自动化过程中使用 Sphinx 创建一组 PDF 文档，但我发现使用 conf.py 中的 Latex_documents 元组可以传递的文档特定信息太有限。我将尝试…
有没有办法隐藏/删除 MyST 特定的语法，以便可以使用常规 Markdown 解析器？
我通常使用 ReST 和 Sphinx 来生成文档，但我正在处理预先存在的 Markdown 系统。我想使用 MyST 和 Sphinx 生成带有参考和 autodoc 的文档，但也使其…
Sphinx automodule：用模拟函数装饰时未记录类方法
我有一堂带有装饰方法的课程。用作装饰器的函数由构建文档时不可用的模块提供，因此使用 autodoc_mock_imports = ['module_with_decorator'] 在 conf.…
Sphinx - 具有自动摘要功能的特定文件文档
我正在尝试使用 Sphinx 的自动摘要扩展来自动生成单个文件的方法的文档。我在 sphinx 上有以下文件夹结构 -docs -source -api.rst -conf.py -src -pla…
如何嵌入<图片>sphinx 文档中的标签？
我发现了以下问题： 我们如何在 sphinx 文档中嵌入图像？ 但是这张图片标签假定文件格式为 jpg 或 png： .. image:: picture.jpg :width: 200px :heig…
使用 sphinx 进行不完整翻译仅显示默认语言？
在遵循官方翻译文件工作流程后，我发现我自己就处于翻译似乎不起作用的情况下。 make gettext sphinx-intl update -p /source/_build/gettext -l fr s…
防止 Sphinx 显示 python 函数参数默认值
在包中，我在 __init__.py 中将全局变量 MyPackage.Data_path 定义为： Data_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'dat…
Sphinx 中的嵌套 URL
假设我在 file.rst 中有两个链接： .. _link1: https://link1.com .. _link2: https://link1.com/val 有没有办法在 link2 中使用 link1 ，就像我下面…
使用 Cerberus 模式自动化文档编制
我们广泛使用 cerberus 来验证 json 配置文件。因此，我们有各种各样的模式，它们定义了这些 json 文档的格式。 我们希望能够使用这些模式为可能需要…
Sphinx 找不到特定目录中的模块
我在 Python 中遇到了 Sphinx 的问题。即使我已按照 https://groups.google 的说明进行操作。 com/forum/#!topic/sphinx-users/lO4CeNJQWjg 我无法解…
