程序员经验分享-hwhale

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

2023-11-27

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

Link to the :ref:`genindex` page.

这会创建：

链接到Index page.

我无法添加genindex到我的目录树，例如像这样：

.. toctree:

   foo
   bar
   genindex

因为它是自动生成的文件，在渲染时不存在。此外，Sphinx 期望 genindex 是一个名为的本地文件genindex.rst.

如何将其添加到我的目录/导航中？


只要没有人发布更好的解决方案，我将写下我的解决方法作为可行的解决方案。

Sphinx 将索引创建为denindex.html在构建根目录中。不能在 a 中引用它toctree指令，因为该指令引用 ReST 文件。那么如何解决呢？

所以让我们创建一个genindex.rst文件并从toctree指示。这也创造了一个genindex.html在构建根目录中。所有链接均按预期创建。这genindex.html文件需要定义一个类似“Index”的标题，用作导航栏中的链接标题。

从 ReST 文件写入所有 HTML 文件后，Sphinx 生成其索引并覆盖genindex.html.

源文件：

源文件index.rst:

.. toctree::
   :caption: Introduction

   chapter1
   chapter2

.. toctree::
   :caption: Main Documentation

   chapter3
   chapter4

.. toctree::
   :caption: Appendix

   genindex

源文件genindex.rst:

.. This file is a placeholder and will be replaced

Index
#####

导航栏截图：

enter image description here

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

Indexing

pythonsphinx

reStructuredText

ReadTheDocs

toctree

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

  • 我应该在 mongodb 中对布尔标志使用稀疏索引吗？

    我有一个布尔标志 finished 我是不是该 A index finished 1 B index finished 1 sparse true C use flag unfinished instead to query by that

  • mysql 部分索引、反向索引

    我有一张包含单词列表的表格 字 VARCHAR 16 我需要创建一个反向索引 IE 单词 apple 将索引为 elppa 单词 banana 将索引为 ananab 依此类推 另外 是否可以索引单词的一部分 例如 跳过第一个 最后一个或

  • 如何交叉引用 Sphinx 中 autodoc 生成的函数？

    我正在使用Sphinx autodoc根据我的 Python 库的文档字符串生成文档的功能 找到交叉引用的语法here http sphinx doc org markup inline html ref role 该部分之前必须有一个标签

  • 根据索引查找金字塔的行？

    给定一个像这样的金字塔 0 1 2 3 4 5 6 7 8 9 并给出金字塔的索引i where i代表i金字塔的第一个数字 有没有办法找到金字塔的行的索引i第一个元素属于 例如 如果i 6 7 8 9 它位于第 3 行 从第 0 行开始

  • MySQL 5.0 索引 - 唯一索引与非唯一索引

    MySQL 唯一索引和非唯一索引在性能方面有什么区别 假设我想在 2 列的组合上创建索引 并且该组合是唯一的 但我创建了一个非唯一索引 这会对 MySQL 使用的性能或内存产生重大影响吗 同样的问题 有区别吗primary钥匙和unique

  • 将solr 1.4索引升级到solr 3.3？

    我有一个使用 apache solr 1 4 构建的现有索引 我想在 3 3 版本中使用这个现有索引 正如您所知 索引格式在 3 x 之后发生了变化 那么如何才能做到这一点呢 我已经使用 Luke 将现有索引 即 1 4 版本 导出为 XM

  • 通过 :ref:? 从 ReST 文档中提取文本块

    我有一些 reStructuredText 文档 我想在在线帮助中使用其中的片段 似乎一种方法是通过引用 剪掉 标记片段 例如 my boring section Introductory prose blah blah blah my i

  • 如何重置 pandas 数据框中的索引？ [复制]

    这个问题在这里已经有答案了 我有一个数据框 从中删除了一些行 结果 我得到一个数据帧 其中索引是这样的 1 5 6 10 11 我想将其重置为 0 1 2 3 4 我该怎么做 以下似乎有效 df df reset index del df

  • Sphinx：将输出 html 分割成比输入文件更小的页面

    假设我有一个 Sphinx 索引文件 toctree foo bar 并且文档 foo 只有一个标题 Foo All about foo 而酒吧有两个 Bar All about Bars Parrot All about ex parro

  • 我想在Java中使用关于随机索引的索引

    我使用Java 当我在Java中使用ArrayList时 如果我随机访问索引号 这可能吗 如果这是不可能的 我应该怎么做 例如 ArrayList

  • 在 Sphinx 中的引用中保留内联代码

    在 Sphinx 中 如果我有以下标题声明 somestuff this is code this is not 它呈现如下 this is code 这不是 这很好 但是 如果我使用参考 例如 Have a look at ref som

  • MongoDB - 解释特定的解释输出

    我使用的是 MongoDB 版本 2 4 8 test 2014 03 25 14 42 13 0 gt gt gt db users getIndexes v 1 key id 1 ns test users name id v 1 ke

  • 在 Oracle 临时表上放置索引安全吗？

    我读过 不应分析临时表 因为它会破坏其他表的统计信息 指数怎么样 如果我在程序运行期间在表上放置索引 使用该表的其他程序会受到该索引的影响吗 索引是否会影响我的进程以及使用该表的所有其他进程 或者它会单独影响我的过程吗 所有的回复都不是权威

  • 如何处理 ReST 中的两个破折号

    我正在使用 Sphinx 来记录用 Python 编写的命令行实用程序 我希望能够记录命令行选项 例如 region像这样 region

  • 对带有空白 NVARCHAR 或 NULL 检查的 VARCHAR 索引进行 Count(*) 会导致返回的行数加倍

    我有一张桌子 上面有VARCHAR列及其上的索引 每当一个SELECT COUNT 是在这张表上完成的 该表检查了COLUMN N OR COLUMN IS NULL它返回双倍的行数 SELECT 与相同的where子句将返回正确的记录数

  • reStructuredText：README.rst 未在 PyPI 上解析

    我有一个托管在 Github 和 PyPI 上的 Python 项目 在 Github 上 https github com sloria TextBlob blob master README rst https github com s

  • 实现 Index 特征以返回非引用的值

    我有一个想要实现的简单结构Index 但作为 Rust 的新手 我在借用检查器方面遇到了许多麻烦 我的结构非常简单 我想让它存储一个起始值和步骤值 然后当由usize它应该返回start idx step pub struct MyStru

  • 查找列表中项目的索引

    给定一个列表 foo bar baz 和列表中的一个项目 bar 如何获取它的索引1 gt gt gt foo bar baz index bar 1 See 文档 https docs python org tutorial datast

  • 外键和索引

    我有 2 张桌子 products and 类别 每个类别有很多产品 一个产品可以属于多个类别 products product id int primary auto increment name unique etc 类别 catego

  • 以编程方式使用 Sphinx 特定指令解析 .rst 文件

    我希望能够在 Python 中解析基于 sphinx 的 rst 以便进一步处理和检查 就像是 import sphinx p sphinx parse path to file rst do something with p 似乎在 do

随机推荐

  • npm install 不安装任何依赖项

    我正在尝试安装软件包package json文件 不幸的是 当我跑步时npm install 什么也没有发生 没有安装任何东西 我用过npm install在其他存储库上并且它可以成功运行 这是我的路径 PATH Users me rben

  • Ruby 中使用 net-sftp 进行基于密钥的身份验证

    我希望能够使用 SFTP 登录多个服务器并下载某些文件 以帮助在问题出现时进行调试 虽然我们可以使用客户端 但我们希望开始自动化流程以简化一切 我的第一次尝试看起来像这样 def download files to download des

  • 通过比较行中的列来过滤 Pandas DataFrame

    我的数据框中的每一行都有两个日期列 如何过滤掉 日期 A 在 日期 B 之后的行 例子 symbol reports at as of signal A 2012 02 15T21 00 00Z 2012 02 01T12 00 00Z 6

  • 强制可选参数使用更广泛的类型，并具有更严格的默认值

    有没有办法进行可选参数f足够灵活 有类型 a gt b 但仍将其默认为identity 鉴于identity有类型 a gt a 之前的一个问题 begins通过准确地陈述我的问题 我想定义一个接受可选参数的函数 该参数是 一个函数 a g

  • 语音中的关键字识别[关闭]

    Closed 此问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 目前不接受答案 有谁知道有一个免费的关键字识别系统 并且可能提供 API CMU Sphinx 4 和 MS Speech API 是语音识别引擎 不能用于 KWS

  • 在 Java 的 main() 中对 Thread 实例运行 wait()

    我正在尝试 java lang Object 中 wait 的定时版本 并观察到它在两种不同场景中的行为有所不同 场景1 使用Thread中run 的默认定义 public static void main String args thro

  • scanf 是否保证在失败时不会更改值？

    If a scanffamily 函数无法匹配当前说明符 是否允许写入成功时存储该值的存储 在我的系统上有以下输出213两次 但这能保证吗 标准中的语言 C99或C11 似乎没有明确规定原始值应保持不变 无论是否不确定 include

  • JavaScript 错误 - 找不到变量：谷歌

    我编写的代码在浏览器上运行得非常好 但是当我连接到 iPhone 上的 wifi 时 我在调试器中收到错误 JavaScript 错误 找不到变量 谷歌 每当我调用任何谷歌地图 方向 地理位置对象时都会发生这种情况 代码如下 map new

  • 使用 SVN 和 Eclipse 正确设置 GWT 项目

    我正在尝试使用 Eclipse 和 Google Web Toolkit 开发一个小项目 这是一个 小型 小组项目 所以我想使用 SVN 到目前为止 我已经在 Eclipse 中创建了一个 GWT 项目并将其添加到我的 SVN 存储库中 问

  • 如何减少 Entity Framework 4 查询编译时间？

    摘要 我们遇到了 EF4 查询编译时间超过 12 秒的问题 缓存查询只能让我们到目前为止 有什么方法可以真正减少编译时间吗 我们可以寻找哪些可能做错的事情吗 谢谢 我们有一个通过 WCF 服务公开的 EF4 模型 对于每种实体类型 我们公开

  • 为什么 Scala 改变了关系运算符与相等运算符的相对优先级（与 Java 相比）？

    在Java中 更新 这实际上是语言规范中的一个错误 在 Scala 中 在Scala 中它不是相反的 尝试这个 val what 5 8 lt 4 我收到编译时警告 comparing values of types Boolean and

  • mysql group by 返回最小值并获取对应行数据

    我有一个像这样的数据表 PK table merchantName price Product 1 argos 7 4 2 comet 3 4 1 Dixon 1 3 1 argos 10 4 我希望在mysql中选择产品的最低价格和相应的

  • 将 ajax 结果附加到 div

    我正在对 IMDb API 进行 ajax 调用 以获取 肖申克的救赎 的电影数据 我希望将这些数据放入我创建的 div 中 div div 我当前的js代码 init function init ajax dataType json ur

  • 如何测量Java线程的执行时间？

    我想测量Java中线程的执行时间 现在我正在监视线程的开始和结束时间 但我认为它不太准确 因为线程在执行期间可能会被挂起 Java MXBeans 可以提供每线程 CPU 时间 import java lang management Man

  • “@+android:id/title”是什么意思？

    正常情况下 我们应该使用 id 定义一个 id 并使用 id引用一个 id 今天我发现 android id title in apps settings res layout preferenc progress xml 如何理解它以及如

  • 比较相等的日期时间返回 false

    我有一个关于如何在 C 中比较 存储日期时间的查询 考虑以下代码 var createdDate DateTime Now using cr new LanguageDictionaryRepository ds cr Add new Sy

  • 在 Rcpp 中构造 3D 数组

    我正在尝试使用提供的维度列表将 1D 数组映射到 3D 数组 这是我的组件 SEXP data my 1D array I can initialise new 3D vector in the following way NumericV

  • Angular ngx-mat-select-search 自定义组件

    我正在尝试使用 ngx mat select search 组件在我的应用程序中放置一个带有搜索栏的 mat select 样式下拉菜单 https www npmjs com package ngx mat select search 我

  • 如何在 Liferay portlet 中设置 Cookie？

    我在尝试设置会话 cookie 时遇到问题Liferay 6 0 portlet 我希望能够向客户端浏览器设置一个 cookie 以存储用于 linkedin 身份验证的应用程序密钥 然后其他 portlet 可以在其中检索它 我可以使用以

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

    我正在 ReadTheDocs 上使用 Sphinx 主题创建我的文档 构建过程会生成一个 genindex html 文件 可以通过以下方式引用该文件 Link to the ref genindex page 这会创建 链接到Index

热门标签