python-sphinx 相关问题

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

从输入中删除注释。注释

假设我有一些类型别名，也许 Point3D = Annotated[tuple[float, float, float], "A 3D Point"] Points = Annotated[list[Point3D, list[float]], "点的集合"] ...

python regex annotations python-sphinx python-typing

回答 1 投票 0

使用 Sphinx autodoc 自动递归记录所有模块

我正在尝试使用 Sphinx 用 Python 记录一个 5,000 多行的项目。它有大约 7 个基本模块。据我所知，为了使用 autodoc，我需要为项目中的每个文件编写这样的代码...

python python-sphinx autodoc

回答 7 投票 0

如何在 ReadTheDocs 导航栏中链接生成的索引页面？

我正在 ReadTheDocs 上使用 Sphinx 主题创建我的文档。构建过程会生成一个 genindex.html 文件，可以通过以下方式引用该文件：链接到 :ref:`genindex` 页面。哪个

indexing python-sphinx restructuredtext read-the-docs toctree

回答 1 投票 0

运行 sphinx-build 会导致 AttributeError: 'Values' object has no attribute 'link_base'

我有一个 Django 4.2 项目，希望运行 Sphinx 来生成文档。当我跑步时 sphinx-build -b html docs_source/ docs/ 我收到以下错误：发生异常：文件 “C:\ProgramData\

python django python-sphinx

回答 0 投票 0

如何通过API在Sphinx/docutils中创建新文档？

我为 Sphinx 编写了一个新的扩展，作为一个为硬件描述语言 VHDL 提供多个指令、角色和索引的域。此扩展应能够自动记录语言

vhdl documentation python-sphinx autodoc docutils

回答 1 投票 0

向使用 rst2pdf 和 Sphinx 生成的 PDF 添加页眉和页脚

我继承了使用 reStructuredText 和 Sphinx 构建的用户指南，我们希望（并且可以）使用 rst2pdf 与 Sphinx 集成来生成 PDF。我们想要的一件事...

python-sphinx restructuredtext rst2pdf

回答 1 投票 0

如何使用 Sphinx 和 ReStructuredText 将图像链接到不同文档中的标题？

我有一个用 Sphinx/rst 编写的文档，我希望有一个链接到不同文件中标题的图像。不知何故，以下内容不起作用，我不知道为什么：在文档中...

python-sphinx restructuredtext

回答 1 投票 0

如何使用 sphinx/ReStructuredText 将图像链接到不同文档中的标题

我有一个用 sphinx/rst 编写的文档，我希望有一个链接到不同文件中标题的图像。不知何故，以下内容不起作用，我不知道为什么：在文档中...

documentation python-sphinx restructuredtext

回答 1 投票 0

参考不同位置的图像

我正在使用Python Sphinx（通过ReadTheDocs）。我有一个包含一些子模块的存储库，我正在尝试创建一个统一的文档，但仍保留每个模块中的文档资产

python python-sphinx restructuredtext read-the-docs

回答 1 投票 0

在 sphinx-doc 中搜索“as you type”

作为 mkdocs 或 mdbook，我希望当您在 sphinx-doc 搜索页面中键入时显示搜索结果。是否可以？如何更改_static/searchtools.js？

python-sphinx

回答 1 投票 0

Sphinx 自动摘要“toctree 包含对不存在文档的引用”警告

我正在尝试使用 Sphinx 自动为大型 python 代码库创建 api 文档。我尝试过使用 build_modules.py 和 sphinx-apidoc。无论使用哪一个，我都可以成功创建第一个文档...

python python-2.7 python-sphinx toctree sphinx-napoleon

回答 5 投票 0

修改 Jupyter book 的内容宽度，或 Sphinx 主题 sphinx-book-theme

我正在使用 jupyter-book，默认情况下使用 sphinx-book-主题。有一个左侧边栏、中间栏的内容和右侧边栏。我想让内容栏更宽。那个...

css themes width python-sphinx jupyterbook

回答 1 投票 0

带锚点的文档之间的链接

我有两个第一个文档，例如：文档1.rst 文档2.rst 文档1.rst 文件1内容 ************** Foo酒吧 ======= 巴兹！文档2.rst 文件2内容 ************** 你可以在这里看到“foo bar” 我有两个第一个文档，例如： doc1.rst doc2.rst doc1.rst Doc 1 content ************* Foo bar ======= baz ! doc2.rst Doc 2 content ************* You can see "foo bar" `here <doc1.html#foo-bar>`. 要在 doc2 中有一个到 doc1#foo-bar 的链接，我可以对其进行硬编码。但是如何在不进行硬编码的情况下实现呢？我可以用 sphinx 代码做到这一点吗？为 doc1.rst 中要链接到的部分定义标签。然后使用 :ref: 角色创建对该部分的交叉引用。 doc1.rst： Doc 1 content ************* .. _foobar: Foo bar ======= baz ! doc2.rst： Doc 2 content ************* You can see "foo bar" :ref:`here <foobar>`. 关于已知锚点的内部链接，doc1.rst和doc2.rst不必位于同一文件夹中，并且您不必提供有关内部锚点位置的路径信息_foobar . doc1.rst Doc 1 content ************* .. _foobar: doc2.rst： Doc 2 content ************* For additional details see :ref:`foobar`. 注意：对内部链接的引用，例如对锚点 _foobar 的引用可以位于生成的文档空间中的任何位置。 doc1.rst 和 doc2.rst 都可以位于文档文件夹空间中的任何位置，Sphinx 将找到适当的锚点/标签。无需提供有关其位置的路径信息。但在生成的文档集中，所有锚点都必须是唯一的。 https://www.sphinx-doc.org/en/master/usage/referencing.html#cross-referencing-profit-locations

python-sphinx

回答 2 投票 0

摆脱 Sphinx 中的“重复标签”警告

在 Sphinx 中，我收到大量警告，例如： /PATH/FILENAME:LINE: 警告：重复标签 LABELNAME，/PATH/FILENAME 中的其他实例似乎将所有部分标题视为“标签”，并且......

markdown python-sphinx restructuredtext commonmark

回答 4 投票 0

以下 ReStructuredText 包含 :ref: 角色，它是 Sphinx 扩展：在:ref:`section-target` 中阅读更多内容。 .. _section-目标：章节标题 ============= 正文。在哪里：参考：`se...

python-sphinx restructuredtext docutils

回答 1 投票 0

reStructuredText 书目字段正确使用

使用 python 文件的 reStructuredText 书目字段的正确方法是什么？

python python-sphinx restructuredtext bibliography

回答 2 投票 0

Docutils 节点中文本和原始源的区别。文本？

创建新节点如nodes.title时，需要提供两个字符串：原始来源文本我经常看到这样的情况：节点.title('foobar', 'foobar', ids=[id]) 或者某个时候... 节点.target('', '') 我会...

python python-sphinx docutils

回答 1 投票 0

Docutils：遍历部分？

如何在Sphinx中遍历文档的每个节名称？（docutils 的文档在哪里？除了 Sphinx 应用程序之外，很难找到任何有用的东西......

python-sphinx docutils

回答 2 投票 0

如何在Sphinx中删除没有空格的子字符串？

我需要在 Sphinx .rst 文件中删除不带空格的子字符串，以与 strikesubstri...

python python-sphinx restructuredtext strikethrough

回答 1 投票 0

如何使用Sphinx在reStructuredText中添加博客样式标签

对于用 reStructuredText 编写并使用 Sphinx 呈现为 HTML 的编程语言文档项目，我想将我的函数分组为逻辑组，例如：字符串（所有字符串函数），...

python python-sphinx restructuredtext

回答 3 投票 0

最新问题

© www.soinside.com 2019 - 2024. All rights reserved.