python-sphinx 相关问题

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

如何在 Sphinx :class: 角色后面添加复数-s

我一直有这个问题，我想写一个这样的文档字符串： def foo(arg): '''将 ``arg`` 添加到 :class:`foo.bar.baz.Argument` 列表中。''' 经过然而，这不起作用，...

python-3.x python-sphinx

回答 2 投票 0

如何在 Sphinx :class: 指令后添加复数-s

我一直有这个问题，我想写一个这样的文档字符串： def foo(arg): '''将 ``arg`` 添加到 :class:`foo.bar.baz.Argument` 列表中。''' 经过然而，这不起作用，...

python-3.x python-sphinx

回答 2 投票 0

将 Sphinx autodoc-skip-member 连接到我的函数

我想使用sphinx的autodoc-skip-member事件来选择某个python类上的部分成员用于文档。但 sphinx 文档并不清楚，我找不到任何例子......

python python-sphinx autodoc

回答 4 投票 0

如何让 Sphinx 在参数描述旁边而不是在函数签名上显示 Python 3 键入类型提示？

我正在使用 Sphinx（制作 HTML）从其函数的 reStructuredText 文档字符串自动生成 Python 3 模块的 HTML 文档。生成的 HTML 文档看起来不错...

python-sphinx python-3.5

回答 2 投票 0

如何制作 Sphinx 的 ReadTheDocs 主题，以便在移动设备上很好地布局函数参数？

Sphinx 的 ReadTheDocs 主题是一个特别漂亮且易于阅读的主题。它在宽度合适的显示器上工作得很好。这是一个例子：它在非常狭窄的情况下也能很好地工作

python-sphinx read-the-docs

回答 1 投票 0

使用 reST 嵌套 Sphinx 扩展指令

我想弄清楚是否有办法嵌套 Sphinx 扩展指令。我有一些运行良好的自定义节点类型，但我希望我生成的 HTML 具有更多的灵活性...

python python-sphinx restructuredtext docutils

回答 2 投票 0

为什么我的 sphinx-apidoc --templatedir 选项没有按预期工作？

我试图自定义./docs/conf.py以使文档管理更容易，所以我执行了以下命令： sphinx-apidoc -F -o "./docs" --templatedir=./templates "." 我

python python-sphinx sphinx-apidoc

回答 1 投票 0

MyST-Parser：自动链接/链接错误跟踪器问题的引用

我使用 sphinx w/ MyST-Parser 进行降价，并且我想要 GitHub 或 GitLab 风格的自动链接 (linkfying) 作为参考。有没有办法让 MyST 渲染参考：第346章用文档来说，这...

markdown python-sphinx docutils

回答 1 投票 0

使用 Sphinx 生成文档时 Flask 会抛出 KeyError

我在 docker 中有一个 python Flask 脚本。该脚本通过以下方式从 docker-compose 获取一些环境变量：应用程序=烧瓶（__名称__） DEFAULT_PSW = os.environ['DEFAULT_PSW'] @app.route(&

python flask python-sphinx

回答 2 投票 0

Sphinx 抛出 KeyError 异常

我在 docker 中有一个 python Flask 脚本。该脚本通过以下方式从 docker-compose 获取一些环境变量：应用程序=烧瓶（__名称__） DEFAULT_PSW = os.environ['DEFAULT_PSW'] @app.rou...

python flask python-sphinx

回答 2 投票 0

Sphinx 文档和重构文本：多行参数定义的替换

我正在用Python开发一个具有数百个函数的项目。其中很多都有一个称为详细程度的参数，我对其进行了如下描述： ”“” 详细程度：int，可选 ...

python documentation python-sphinx restructuredtext

回答 1 投票 0

sphinx.ext.autodoc：外部包的 ModuleNotFoundError

我想开始使用 Sphinx 记录我的基于 Flask 的应用程序。目前，我正在尝试弄清楚如何使用 autodoc 扩展。我的本地模块都找到了，但是外部的导入

python flask python-sphinx autodoc

回答 1 投票 0

如何将 Sphinx 指向自定义主题

注意：我之前曾问过这个问题，但因为我放弃了该项目而删除了它，但现在我实际上需要找出如何解决。我正在尝试制作 Sphinx 主题，但我无法让 Sphinx 检测到...

python-sphinx custom-theme

回答 1 投票 0

reStructuredText (Sphinx) 列表的“多重枚举”形式

是否可以在ReStructuredText（Sphinx）中制作自动枚举列表，例如 1. 第 1 点 1.1.第 1.1 点。 1.2.第 1.2 点。 2. 第 2 点。有什么指令或其他方法吗？应该是类似的...

python-sphinx restructuredtext

回答 1 投票 0

Sphinx“autodoc”扩展甚至无法找到保证存在的标准模块

我正在尝试记录 beartype 的公共 API，beartype 是一个用于 Python 的 berry fun 运行时类型检查器。我彻底失败了。 Sphinx 的 autodoc 扩展无法找到标准的纯 Python CPython 模块

python python-sphinx autodoc

回答 1 投票 0

如何防止sphinx在交叉引用的目标中将大写字母替换为小写字母？

这是因为我目前正在使用 sphinx 将旧文档更改为新文档。旧文档使用 t2t 文件，其中我有很多用大写字母编写的参考文献...

python-sphinx restructuredtext

回答 1 投票 0

删除jupyterbook中的浅色/深色主题管理

我创建了一个 Jupyter Book，我想禁用浅色/深色主题管理选项。我设法发现这可以通过修改

python-sphinx jupyterbook

回答 1 投票 0

阅读文档构建的某些页面有空白 html

我们使用 read-the-docs 和 sphinx 为 GitHub 上托管的包构建文档。该文档包括 .ipynb 文件（Python 笔记本），这些文件在 readthedocs Web p 上呈现为 HTML...

python-sphinx read-the-docs

回答 1 投票 0

将 CSS 类添加到 Sphinx 生成的锚范围

使用此 RST 文件： ..cssclass::myclass .. _重要的：一些非常重要的事情 -------------------------- ...这个电话： sphinx-build -C ./ ./html ./index.rst ...以下 HTML 结果...

python-sphinx restructuredtext

回答 1 投票 0

将图像/图形添加到目录

我正在使用雪花石膏狮身人面像主题，并且每个页面上都有本地目录（TOC），其中自动包含我的章节标题。有没有办法在目录中也包含图形/图像？ ...

python-sphinx figure restructuredtext tableofcontents

回答 1 投票 0

python-sphinx 相关问题

最新问题