python-sphinx 相关问题

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

没有名为“regression_testing.common”的模块 Python Sphinx

Repo 就是这样,有 2 个文件夹用于“单独模块”regression_testing_package 和 regressin_testing_common,但两者共享相同的命名空间,regression_testing 均通过

回答 1 投票 0

sphinx 使用自托管 gitlab 阅读源代码上的文档编辑

此处提到的在 sphinx 文档页面上添加“编辑源”按钮的过程在公共 GitLab 存储库上运行良好。 html_上下文 = { “display_gitlab”:正确,#

回答 1 投票 0

如何链接/引用文档中的另一个 reST 文件?

我根本不知道如何链接到 reST 文件中的另一个文档。 我想将名为 install.rst 的文件链接到我的快速入门指南的一个段落中。我不知道如何才能实现这一目标。 普...

回答 8 投票 0

如何在 Sphinx 中使用 nitpick_ignore_regex 和 linkcheck 解决 403 错误?

我在 Sphinx 中使用 make linkcheck 来查找文档(.rst 文件)中损坏或有其他问题的链接。我修复了所有链接,但两个 Intel 链接不断出现以下 403 ...

回答 1 投票 0

sphinx 使用 Latexpdf 在我的 pdf 中添加分页符?

我使用 Latexpdf 和 sphinx 生成从 rst 到 pdf 的文档。 如何在 PDF 中添加一些分页符(=新页面)? 目前我使用 PageBreak,但它仅适用于 rst2pdf。 ..原始::pdf

回答 3 投票 0

Sphinx + reStructuredText 中的内联代码链接

在 Markdown 中,可以像这样创建内联代码链接 [`dict.update`](https://docs.python.org/3/library/stdtypes.html#dict.update) 其呈现方式类似于 dict.update。如何获得类似的行为...

回答 2 投票 0

尽管在conf.py中排除了,Sphinx仍然为测试文件夹生成文档

我正在使用 Sphinx 为我的 Python 项目生成文档,并且我想将测试文件夹排除在生成的文档中之外。我已将“**/tests/*”添加到

回答 1 投票 0

Sphinx 对从 IntEnum 派生的类发出警告 - 我可以对此做些什么吗?

正如标题所说。警告是: liesel.goose.EpochType.from_bytes:9 的文档字符串:警告:内联解释文本或短语引用起始字符串,没有结束字符串。 liesel.goose 的文档字符串。

回答 1 投票 0

如何使用sphinx扩展创建新文档

从 sphinx 扩展程序中,如何在调用我的扩展程序的当前文档下创建新文档(新页面)。即,我有一个从第一个文件调用的扩展名。 就像是: foo.r...

回答 1 投票 0

为什么我在 Sphinxcontrib-httpexample 中使用 python 时没有获得 JSON 属性的换行符?

我正在尝试在 sphinxcontrib-httpexample 中添加一个新选项卡,例如curl、httpie、python-request。我已经进行了所需的更改,除了输出格式之外,一切都正常。 JSON 文件: 发布/

回答 1 投票 0

如何使用Python获取JSON属性的换行符?

JSON 文件: { “项目”: [ { “项目1”:“/xyz” }, { “项目2”:“/yzx” }, { &

回答 1 投票 0

使用 Sphinx 和函数指令在侧边栏中显示带有破折号的函数名称

我正在使用带有 Furo 主题的 Sphinx 7.2.5 和非 Python 的文档函数,因此其名称中可能包含破折号。函数指令通常按预期工作,除了

回答 1 投票 0

如何在 reStructuredText (reST) 中使用 Unicode 字符?

我需要在 Sphinx 文档中使用 Unicode 字符。 当我插入该行时 .. |哦帽子| unicode:: U+00F4 .. 噢 在文件顶部,仅当“|ohat|”时,我才会得到“ô”是

回答 1 投票 0

Sphinx 和 doxysphinx,如何使用 doxygen html 文件而不是在导航面板中跳转?

仅信息: 尝试同时使用 Sphinx 和 doxygen html 链接。 例如,我有在 sphinx 环境中使用的 .rst 文件并设置 toctree 等。 我尝试过使用 :隐藏:

回答 1 投票 0

Sphinx自定义指令解析markdown

所以,我知道我可以通过nested_parse调用嵌套在指令中的内容的解析,即: vl = docutils.statemachine.ViewList(inputLines,source=self.content.source,parent=self.content,parent_...

回答 1 投票 0

使用Sphinx生成文档时继承类文档字符串

在使用 Sphinx 生成文档时,我尝试从父类继承文档字符串。这是一个最小的重现: @数据类 A类(): ”“” 属性: A: ...

回答 1 投票 0

sphinx:通过 raw:: Latex 包含 .eps 图像

我想使用 raw:: Latex 命令在 sphinx 中添加 eps 图像。我想象这样的事情: .. 原料:: 乳胶 \includegraphics[宽度 = 100mm,高度 = 100mm]{example.eps} 奔跑...

回答 1 投票 0

将类添加到 Sphinx 中的表中?

我首先有一个表,我想在使用 Sphinx 编译为 HTML 时向其中添加一个类。根据文档,在表之前添加 .. class:: 指令应该将类添加到表中,...

回答 2 投票 0

隐藏 Sphinx 文档中的单个部分

我找不到处理此问题的指令。 假设有一个第一个文档,并且出于某种原因您想在构建过程中隐藏单个部分(无论是 HTML、PDF ..),例如: 可见

回答 3 投票 0

渲染 .rst 文件内 markdown 文件的输出

我正在使用 Sphinx 来记录 Python 项目,并且希望将现有 .md 文件中的内容显示在 .rst 文件内。 (我已经设置了我的conf.py以允许降价)....

回答 2 投票 0

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