Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。
使用 sphinx，我使用以下语法包含了一个图形。 .._struct_NiO： ..图::img/NiO.png ：居中对齐 ：宽度：400px 字幕很长很长... 在世界的另一部分...
我正在构建一个 HTTP API，并将大量代码分解到一个超类中，该超类处理对对象集合的请求。在我的子类中，我指定操作应该使用哪些数据库模型...
这些是我从 Sphinx 收到的错误： 意外的缩进： [{ “资源”：“/c：/Users/User/Documents/GitHub/MIMIC/mimic/model_simulate/base_model.py”， “主人&qu...
如果存在超链接，如何翻译Sphinx的'parsed-literal'指令的内容？
问题描述 最近，我尝试使用 gettext 生成器生成的 gettext .po 文件来构建 CMake 文档。但是，我想知道如何翻译 parsed-lite 的内容...
是否可以在 Jupyter Book 的 HTML 输出中调整右侧目录深度（名为 Contents）？我想查看我在 Jupyter Notebook 中编写的每个标题。 默认情况下仅...
我是狮身人面像的新手， 我尝试在conf.py中使用 html_theme = 'sphinx_rtd_theme' 但当我运行“make html”时，我收到以下消息： 自版本 1 以来，sphinx_rtd_theme 不再是硬依赖项....
我正在尝试引用狮身人面像|版本|在我的 .rst 文件中的等宽块中（周围没有空格），如下所示...... 您可以使用以下命令安装 foo_project 库： ``pip install -U foo_project==|ve...
我正在使用狮身人面像主题雪花石膏。如何在电脑上获得更宽的屏幕？
窗口的内容部分对于我的预期用途来说太窄了。 我已经在 html_theme_options 中尝试了“body_max_width”：“none”。 我还尝试过“custom.css” .wy-nav-cont...
我正在使用 Sphinx 记录我的库。我有装饰器logic_object： 类逻辑对象： """逻辑对象类的装饰器。 ”“” def __init__(self, cls): self.cls = cls ...
使用Python3.11 Sphinx 7.2.6生成的HTMLHELP文件无法使用hhc.exe编译
我们的软件使用Sphinx来生成文档、网站、chm等... 我们正在尝试从 python2.7 切换到 python3.11 阻塞点之一如下： 我们运行 sphinx -b htmlhelp...
我有以下文档字符串： def 测试（foo）： “”“这是我的功能 .. 代码块:: python 炫酷功能 现在我应该在代码块之外。 乙...
Napoleon 过度转义参数名称中的尾随下划线，导致未知目标名称错误
我现在正好遇到了本期中描述的问题：https://github.com/sphinx-doc/sphinx/issues/7734。该期还提供了 MWE。 我的问题只是看不到修复...
sphinx-autodoc 忽略 conf.py 中的默认设置
我们有一个Python项目，这样做是为了生成文档： sphinx-apidoc --module-first -f -o 源/ ../src 制作html 在最近的 sphinx (6.1.3) 中，我们注意到一个问题。其中一个班级有一个 cl...
Python sphinx 自动摘要错误：“未知指令类型“自动摘要””
我有一个 sphinx 文档，当我包含以下几行时： .. 当前模块:: myMod ..自动摘要:: 我的课 我收到以下错误 错误：未知的指令类型“自动摘要”。 然而，
我使用 Sphinx 生成 HTML 和 PDF 文档。到目前为止，默认的 PDF 输出还可以，但我的经理给我发了一个 Word .dotx 模板，并说 PDF 应该是相同的“企业”风格......
我的index.rst中有一个目录树，看起来像这样： .. 目录树:: ：最大深度：2 猫 狗 驼鹿 我希望嵌套我的 toctree 的内容，类似于它的完成方式......
Sphinx 警告：无法从模块 `pythontemplate` 导入 test.test_adder
上下文 创建 root_dir/docs/source/conf.py 并自动为 root_dir/src （和 root_dir/test/）目录（及其子目录）中的每个 .py 文件生成 .rst 文件后，我
我想在 sphinx 网站中居中对齐并加粗标题，在 markdown 文件中定义为： # 我的标题 我试过把 .center h1 { 文本对齐：居中； } 在 _static/css/c...
我正在编写文档，我想包含 pdf 文件或 zip 档案的链接。我如何使用 rst 语言和 sphinx 来实现这一目标？ 如果我这样做 这是一个 pdf 文件：`pdf 我正在编写文档，我想包含 pdf 文件或 zip 档案的链接。我如何使用第一种语言和 sphinx 来实现这一目标？ 如果我这样做 here is a pdf file : `pdf <doc/mypdf.pdf>`_ 它不起作用，因为在编译期间 sphinx 不复制 doc 目录的内容（我使用 sphinx-quickstart 生成的 makefile）。 相反，使用 image 指令： .. image:: img/plop.png sphinx 会复制构建目录中的 plop.png 图像。如何获得 pdf 或 zip 存档的相同行为？ 解决方案是使用 :download:“角色”（有关角色的 sphinx 文档中有详细介绍）。 这是一个简短的示例，假设您在目录 mypdf.pdf 中有一个文件 doc。目录 doc 和您的第一个文件必须位于同一目录中： here is a pdf file :download:`pdf <doc/mypdf.pdf>` 请注意，:download:和文件路径之间不能放置空格。 image指令仅适用于带有 PDF 文件的 HTML。 .. image:: doc/mypdf.pdf 请勿使用它，因为它具有误导性。感谢 G. Milde 的评论。
我从事一个开源项目，该项目由 python API 以及许多扩展模块组成，这些扩展模块作为单独的 python 包安装。所有这些扩展都位于自己的 github 中