Sphinx是一种工具,可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档,但它是一个通用工具,可用于记录任何内容。
我找不到处理此问题的指令。 假设有一个第一个文档,并且出于某种原因您想在构建过程中隐藏单个部分(无论是 HTML、PDF ..),例如: 可见
我正在使用 Sphinx 来记录 Python 项目,并且希望将现有 .md 文件中的内容显示在 .rst 文件内。 (我已经设置了我的conf.py以允许降价)....
我正在尝试做的事情: 我正在为课程创建在线笔记。我正在使用 Spinx (reStructuredText)。我真的很想用自定义的着色方案创建一些编号的警告(例如 bl...
我正在使用 sphinx 构建我的 lib 文档并通过 ReadTheDoc 网站提供服务。 我正在使用 list-table 指令创建项目的数据源表。 我想要第一栏...
我有一个用例,我不希望 Sphinx 自动为我的部分生成锚点,因为我有多个具有相同标题的部分。 标题 ----- 示例文本 标题 ----- 更多样品
在我的 Sphinx 文件之一中,我有以下内容: .._pyjnius: 皮尼乌斯 ======= 在 Android 上运行时,会出现一个版本的 `Pyjnius `_ 图书馆可用。 ...
我有 SVG 图像文件,其中有多个节点,每个节点都与 URL 关联。如果我直接在浏览器中打开此文件,我可以单击每个节点,它将打开不同的 URL。然而当我使用这张图片时...
如何对齐图像但不让文本环绕图像?一种方法是删除 .figure.align-left {浮动:左;} 来自 CSS,但这可能会破坏其他东西 - RST 中任何更干净的东西(我很清楚......
在Sphinx中,是否可以使用小写字母列表(a.、b.、c.等)来代替(或从属于)编号列表(1.、2.、3.等)。 )?
我想要一个使用小写字母而不是数字的有序列表。我特别想将其作为一个从属于使用数字的列表的列表来执行: 1. 废话...
如何通过在 python-sphinx 中使用角色来使用唯一的内联指令?
在 python-sphinx 中,有唯一的指令,可用于根据文档的输出有条件地影响文档。例如,文本仅以 html 或 Latex 形式出现。 就像这样使用...
我正在用 Python 编写一些数学代码并使用 Sphinx 来生成文档。我知道 Sphinx 可以处理 Python 文档字符串中的 LaTeX 代码;请参阅 https://www.sphinx-doc.org/en/master/u...
如果我使用 sphinx-quickstart,我会被问及项目的版本。 我想避免我的项目版本有两个地方。 在 python 打包世界中如何做到这一点?
如何使用 ReadTheDocs 指定 plantuml 版本?
我正在尝试在 ReadTheDocs 上托管的 Sphinx 项目中使用 PlantUML。我想知道如何指定要安装的 PlantUML 版本,因为它当前正在安装旧版本,这会...
我为 Sphinx 编写了一个扩展,用于读取代码覆盖率文件并将其以表格形式呈现在 Sphinx 生成的 HTML 文档中。 目前该表有一个标题行,例如3 列
我在conf.py的序言中声明了一个自定义环境,它有6个参数 % 要求风格/格式 ewenvironment{sphinxclasscustomizedrequirement}[6]{ 尺{15cm}{1pt}\ \
Sphinx:在 LaTeX 构建中隐藏 `{contents}`
index.rst ======================================= 我的标题 ======================================= .. 原料:: 乳胶 \section*{我的标题} 一些文字 .. 目录树:: :隐: :仅标题: :
我有一个用sphinx构建的python包和网站。我希望包含一个包含可以填写的表单的页面: 电子邮件 (*): 问题1: 问题2: ... 证实 经验证...
sphinxcontrib.applehelp 打破 sphinx 版本低于 5.0 的 sphinx 构建
2024 年 1 月上旬,我所有的 sphinx 构建都失败了,当我执行 make html 时出现以下消息: 本项目使用的sphinxcontrib.applehelp扩展至少需要Sphinx v5.0;因此它可以...
禁用 Sphinx ReadTheDocs 主题中的顶部导航栏(面包屑)
我想禁用 ReadTheDocs 主题的顶部导航栏。对于其他主题,例如经典,它只是一个选项 html_theme =“经典” html_主题选项 = { “showrelbartop”:
Sphinx automodule:如何引用同一模块中的类?
我正在尝试使用 sphinx autodoc 扩展,特别是 automodule 指令来自动为我正在开发的 django 应用程序生成文档。问题是我想创建