python-sphinx 相关问题

Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。

RestructuredText 中的文字“*”

我正在看这段代码： def ook(*args): """一些愚蠢的功能。 :param *args: 可选参数。 """ ... 一旦我运行 Sphinx，我就会得到非常有用的错误：

python python-sphinx restructuredtext

回答 3 投票 0

清理 sphinx-doc protobuf 类型

我觉得我之前已经弄明白了，但它不再起作用了，我正在开发一些基于 protobuf 和 grpc 的代码，并且在文档中所有类型都非常混乱：

python python-sphinx protobuf-python

回答 1 投票 0

为 Sphinx 生成的 PDF 文件添加注释的背景颜色？

我可以使用 Sphinx 指令生成笔记 .. notes::.但是，html 文件中的注释具有背景色，而生成的 PDF 中的注释则没有。我怎样才能给狮身人面像添加颜色-

latex python-sphinx restructuredtext

回答 5 投票 0

有没有办法在 reST 文本中使用 TAB 缩进？

我是 TAB 用户，使用 TAB 缩进 Python 文本和其他代码。但是 reST 需要精确的缩进空格数，并且空格的数量根据其上下文而不同。他们是

tabs python-sphinx indentation restructuredtext

回答 0 投票 0

包含的 Makefile 和 Linux 文档不起作用

我正在尝试创建与 Linux 内核相关的文档。我克隆了存储库，并且输入了 linux/Documentation。当我运行 make xmldocs 时，我收到错误：狮身人面像建造

linux makefile linux-kernel python-sphinx

回答 1 投票 0

如何激活 RTD 弹出菜单？

我正在使用 Sphinx 和 ReadTheDocs 来构建我的项目的文档。我想向我的最终用户显示多个版本，所以我在我的管理区域中建立了几个分支：但是当我展示...

python-sphinx read-the-docs

回答 1 投票 0

使用 sphinx autodoc、autosummary 和 autodoc_pydantic 隐藏模块路径

我将 Sphinx 与 autodoc 和 autosummary 结合使用，使用 autodoc_pydantic 为 pydantic 模型生成文档。该模型非常复杂，在各种文件和 inc 中有很多子模型......

python-sphinx pydantic autodoc autosummary autodoc-pydantic

回答 0 投票 0

为强调行设置行字符限制（代码块指令）

当我现在这样做的时候 .. 代码块:: python ：强调线：3,5 定义 some_function(): 有趣 = 错误 # 116 个字符行 print('这一行被高亮了。但是...

python documentation python-sphinx

回答 0 投票 0

为 sphnix 强调行指令设置行字符限制

当我现在这样做的时候 .. 代码块:: python ：强调线：3,5 定义 some_function(): 有趣 = 错误 # 116 个字符行 print('这一行被高亮了。但是...

python documentation python-sphinx

回答 0 投票 0

没有 HTML 替换为用于 XML 输出的 Doxygen erbatim 块

问题我的一个标题中有以下片段： /** * @brief 简单的功能。 * * @逐字 * 不希望将以下内容呈现为 <: > 或 \> ！ * @endver...

python-sphinx doxygen

回答 0 投票 0

如何告诉 sphinx-apidoc 覆盖特定 Python 类的选项？

我遇到了 https://github.com/sphinx-doc/sphinx/issues/8664 中描述的问题，其中我有一个带有类型注释成员和 Google 风格属性的类：pydocs，例如。：类...

python python-sphinx autodoc

回答 1 投票 0

Sphinx 搜索结果会在本地自动扩展（带预览），但不会在网络上

对于 sphinx 构建的 html 文件（来自 rst 文件）。预期的搜索结果应该如上所示，因此用户可以预览。但是，我的项目中的搜索功能无法正常工作，j...

search python-sphinx read-the-docs

回答 0 投票 0

如何在包含某些图像的相对路径的 sphinx 中呈现 readme.md

我正在使用 m2r2 使用 sphinx 呈现 html 文档。我的文件夹结构是项目 |_ 文档 |_ 狮身人面像根 |_ 自述文件.md |_ image_to_include_in_readme.png README.md 看起来像这样： # ...

python python-3.x python-sphinx

回答 1 投票 0

可以有狮身人面像MyST渲染美人鱼

MyST md 驱动程序可以在 .md 文件中制作美人鱼吗？现在我找到的唯一方法是 $ 尾部配置文件.py extensions = [ 'recommonmark', 'sphinxcontrib.mermaid'] 来自推荐。

python-sphinx mermaid myst

回答 2 投票 0

在 Sphinx 中，有没有办法为内联和显示数学模式使用不同的数学渲染引擎？

我可以使用 sphinx.ext.pngmath 来显示数学表达式，使用 sphinx.ext.mathjax 来显示内联数学表达式吗？我问的原因是我有几个用

python-sphinx docx mathjax

回答 0 投票 0

无法通过 GitLab（docker）管道使用 Django 构建 sphinx autodocumentation

这个问题可能很具体。我的设置这是我的项目结构。这是一个 Django 项目。 ├── 文档 │ ├── 建造 │ │ ├── 教科书 │ │ └── html │ ├── 生成文件 │ └── 出处 │ ...

python django gitlab python-sphinx gitlab-ci-runner

回答 1 投票 0

如何使用 Sphinx 记录 Python 函数参数？

我正在尝试清理我的 python 代码文档，并决定使用 sphinx-doc 因为它看起来不错。我喜欢如何使用标签引用其他类和方法，例如： :class:`mymodule.MyC...

python python-sphinx documentation-generation

回答 3 投票 0

如何在 python docstring 中指定不同的返回类型

我目前正在使用 Sphinx 和 autodoc 插件为我的 python 包编写文档。对于函数返回值，我可以例如write :returns: int: count 告诉狮身人面像有一个 ...

python python-sphinx docstring autodoc

回答 2 投票 0

sphinx gettext 在先前匹配的 msg 前面插入空引号“”

当前，当我更改原始文件中的内容时，我的工作流程是这样的：使 gettext 更新 *.pot 文件 sphinx-intl update -p build/gettext -l fr 从中创建 *.po 文件然而，这...

internationalization python-sphinx gettext po

回答 1 投票 0

使用'./subfolder/xxx.csv'无法从代码中的变量中找到使用 Sphinx 的子目录

这是我在 Windows 10 x64 中的文件夹树，我使用的是 conda python (3.9.16) 和 Sphinx 6.1.3： ├────贸易追踪 │ ├────文档 │ │ ├────_build │ │ │ ├───doctrees │ │ │ └────html │ │ ...

python python-sphinx

回答 0 投票 0

python-sphinx 相关问题

最新问题