如何在每个页面的侧边栏中包含目录树

2024-03-07

我正在 Sphinx 中生成 html 文档。

如何修改文档中每个 html 页面的侧边栏,以便它们包含目录树?默认情况下,目录树似乎只显示在master_doc页面,并且仅在主区域而不是侧边栏。

是否有捷径可寻?我将使用 readthedocs 来托管生成的文档,因此我宁愿避免使用任何第三方插件,除非它们也可以在 readthedocs 上使用。


您可以自定义 html 侧边栏conf.py.

默认的 html 侧边栏由 4 个模板组成:

['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']

In conf.py您可以将 localtoc.html 更改为 globaltoc.html,如下所示:

html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] }

由于这最终将在 HTML 文件中使用,因此这应该适用于 ReadTheDocs。

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

如何在每个页面的侧边栏中包含目录树 的相关文章

  • 让 Sphinx 替换文档字符串文本

    我正在 Sphinx 中记录类似于以下内容的代码 class ParentClass object def init self pass def generic fun self Call this function using run P
  • python的sphinx中var、cvar和ivar有什么区别?

    我正在阅读 sphinx 文档页面 讽刺的是发现关于 var ivar 和 cvar 之间差异的文档非常缺乏 我想知道是否有人可以解释内联代码中每个不同名称空间之间的区别 Example class foo object var str f
  • 如何在自定义 python-sphinx 指令/扩展中使用现有指令?

    我想创建一个自定义的Directive使用现有指令 code block在这个例子中 在它的实现中 reStructuredText 中的手动等效项是 mydirective py code block py print Hello wor
  • 带注释的狮身人面像树

    通常使用toctree在狮身人面像中看起来像这样 toctree maxdepth 2 foo bar baz 举例来说 如果foo rst以标题 Being Foo 开头 bar rst从 做酒吧 开始 并且baz rst以 Thinki
  • 如何在 RST/阅读文档的代码块中添加复制按钮

    我一直在编写个人 操作方法 指南 记录并保留我的学习日记 我现在有一个几乎太长的代码块 当我自己遇到这么长的代码时 试图仅突出显示该代码块而不突出显示整个页面 或者还不够 总是令人沮丧 所以 我的问题是 对于rst 重构文本 code bl
  • MvvmCross 5.x 的 MvvmCross 侧边栏导航

    我要为我的应用程序实现两种类型的导航 即侧边栏导航和父子导航 我的应用程序从汉堡 侧边栏 菜单开始 侧边栏菜单中的第一项应执行导航堆栈的重置并打开主视图 主视图控制器应该启动根堆栈导航 因此主视图上的每个按钮都应该打开一个新视图 新视图上的
  • 使用 RestructedText 和 Sphinx 包含预格式化文件

    我正在尝试使这个片段发挥作用 Version History These are the versions over time include CHANGES txt 也就是说 使用 include 指令将文件作为块引用包含在内 一旦进入块
  • Visual Studio代码侧边栏垂直引导线(自定义侧边栏)

    有人知道 Visual Studio 代码的扩展可以像 netbeans 一样在侧边栏 用于文件和文件夹 上显示垂直指南吗 或者vscode中有一些设置吗 Netbeans 快照 https i stack imgur com CFJsw
  • PyCharm 和 reStructuredText (Sphinx) 文档弹出窗口

    让我们想象一下 我想看到一个简单方法的文档字符串弹出窗口PyCharm4 5 社区版 也在 5 0 中尝试过 我在两个文件中都写下了这些文档字符串epytext语法 自 2008 年起不再支持 Epydoc 生成器 并且仅适用于 Pytho
  • 在 sphinx 侧边栏中启用版本阅读文档主题

    我想将 versions html 包含在侧边栏中 但无法成功 我尝试在 中为侧边栏添加 versions html 但这没有效果 html sidebars versions html 另外如何声明不同的版本conf py 我看过sphi
  • 如何将单个部分中的 Sphinx 章节分成不同的文件?

    我正在使用出色的 Sphinx 工具来创建一些文档 并且我试图通过将同一部分的章节分成单独的文件来保持代码库的模块化形式 请参阅此处了解 章节 和 部分 的定义 http www sphinx doc org en stable rest
  • Sphinx——结合自动模块和自动类

    除非我错过了什么 斯芬克斯的automodule只会记录模块的成员 而不记录该模块中定义的类的属性 有办法吗自动地得到的行为automodule and autoclass以这样的方式组合 我可以自动获取模块成员的文档and在该模块中找到的
  • 如何有条件地将文件包含在 Sphinx 'toctree' 中? [复制]

    这个问题在这里已经有答案了 我想仅在设置了某个标签时才将我的文件之一包含在 Sphinx TOC 中 但是明显的方法失败了 toctree maxdepth 5 index core utils oec plotting install n
  • 如何将主页包含在 Sphinx 目录中?

    假设我有一个 Sphinx 项目 其来源如下 index rst installation rst templating index rst module rst fieldtype rst index rst 主页 具有以下目录树 toc
  • Sphinx:将输出 html 分割成比输入文件更小的页面

    假设我有一个 Sphinx 索引文件 toctree foo bar 并且文档 foo 只有一个标题 Foo All about foo 而酒吧有两个 Bar All about Bars Parrot All about ex parro
  • 在 Sphinx 中的引用中保留内联代码

    在 Sphinx 中 如果我有以下标题声明 somestuff this is code this is not 它呈现如下 this is code 这不是 这很好 但是 如果我使用参考 例如 Have a look at ref som
  • 如何处理 ReST 中的两个破折号

    我正在使用 Sphinx 来记录用 Python 编写的命令行实用程序 我希望能够记录命令行选项 例如 region像这样 region
  • Wordpress - 排除某个类别出现在菜单或侧边栏小部件中

    是否有一个简单的解决方案 例如插件 来排除菜单或侧边栏中出现的类别 我创建了一个名为 视频 的帖子类别 它显示 YouTube 视频 自然 但后来我意识到它们显示在我的 最近帖子 侧边栏中 我正在寻找一种简单的方法来排除它们 任何想法将不胜
  • 以编程方式使用 Sphinx 特定指令解析 .rst 文件

    我希望能够在 Python 中解析基于 sphinx 的 rst 以便进一步处理和检查 就像是 import sphinx p sphinx parse path to file rst do something with p 似乎在 do
  • 在 Sphinx 文档中*仅*显示文档字符串?

    Sphinx有一个功能叫做automethod从方法的文档字符串中提取文档并将其嵌入到文档中 但它不仅嵌入了文档字符串 还嵌入了方法签名 名称 参数 我如何嵌入only文档字符串 不包括方法签名 ref http www sphinx do

随机推荐

  • 有没有办法在 C++ 函数中获取函数名称?

    我想实现一个函数跟踪器 它可以跟踪函数执行所花费的时间 我有以下相同的课程 class FuncTracer public FuncTracer LPCTSTR strFuncName in m strFuncName 0 T 0 if s
  • SharpSVN 和 C# 问题

    当尝试将 SharpSVN 添加到我的 C 项目时 使用 SharpSVN 相关调用进行编译会出现以下错误 FileLoadException 未处理 混合模式程序集是针对运行时版本 v2 0 50727 构建的 如果没有附加配置信息 则无
  • Jenkins 作业和项目之间的区别

    当我位于 Jenkins 主屏幕上时 我会收到一个链接Create a New Job 当我创建一个新作业并将其称为 新作业 并运行它时 我会得到结果 当我查看结果时 我会收到一个链接Back to Project 当我点击这个时我看到Pr
  • SwiftUI TextField 最大长度

    是否可以设置最大长度TextField 我正在考虑使用处理它onEditingChanged事件 但仅在用户开始 完成编辑时调用 而在用户键入时不会调用 我也阅读了文档 但还没有找到任何东西 有什么解决方法吗 TextField text
  • 如何使用 jQuery 删除周围的 DIV?

    在 Wikispaces 中 当您将目录添加到主要内容区域时 您在该主要内容区域中使用的任何标题 h1 h6 都会自动放置在目录中 并作为锚链接 单击该链接后 带您向下翻页至目录中引用的标题 默认情况下 wikispaces 用 div 包
  • 如何在 r 中创建水平堆积条形图风格的时间序列图

    我想创建一个水平 堆叠条形 类型图 其中日期沿 x 轴运行 我的样本在 y 轴上显示为条形 在下面的简单示例中 我有三个样本 a b c 每个样本包含三个值 0 1 2 我希望水平条根据沿 x 轴的每个时间步长的值进行着色 这样我最终会得到
  • 流媒体 YouTube 视频

    我正在编写一个使用流媒体播放 YouTube 视频的应用程序 第一种方法 我正在使用 GData API 获取视频的 RTSP URL 这是播放 RTSP url 的代码 VideoView mVideoView new VideoView
  • 模式中的表单输入未按要求显示

    我已经阅读了一些相关文章 但没有成功解决我自己的让表单字段按要求显示的问题 也许问题出在外面 但我想分享一下 以防它突出一个独特的案例 这是一个可以完整查看的课堂作业here https futurethang github io Trai
  • Angular 5,具有 3 种状态的 Angular Material 复选框(选中、未选中、不确定)

    我是 Angular 和 Angular Material 的新手 现在我在一些项目中担任支持人员 有一个带有过滤器和一个复选框的网格 用于检查网格中的用户是否处于活动状态 非活动状态或未选择状态 如果只有两个选项 活动 非活动 会更简单
  • 媒体查询最大宽度与视图端口大小或窗口大小有关?

    我想知道媒体查询的最大宽度是否与视图端口大小或窗口大小有关 例如 我有这个媒体查询 media screen and max width 360px 当视口大小为 360px 或窗口大小为 360px 时 此媒体查询会起作用吗 这是视口 这
  • 使用 preg_replace 替换 php 中出现的所有内容

    正则表达式绝对是我的弱点 这个让我完全难住了 我正在构建一个相当基本的搜索功能 我需要能够根据以下模式更改用户输入 Subject 22first set 22 22second set 22 drupal wordpress 期望的输出
  • Selenium 2.42.2 webdriver 与 Firefox 27.0.1 兼容吗? [复制]

    这个问题在这里已经有答案了 Selenium 2 42 2 webdriver 与 Firefox 27 0 1 兼容吗 如果不兼容 那么它与哪个 Firefox 版本兼容 我正在使用 Selenium 2 42 2 网络驱动程序 我写的测
  • memcached 使用 Django 监听 UDP

    Question 我无法获得memcached正在听UDP 上班 get set delete 与姜戈 我只让 memcached 监听UDP 11211 正如我在上一个问题 https stackoverflow com question
  • 具有 Enum 类型属性的 WPF 用户控件

    我有一个UserControl called InputSensitiveTextBox继承自TextBox 它有一个我定义的属性CurrentInputType 其类型为MyControlsNamespace SupportedInput
  • 如何:旋转选定/设置的图像 (Flutter)

    从图像选择器 画廊 相机 中选择图像后 我成功地将图像旋转为横向 纵向 这工作正常 并将继续将新图像设置为我想要的方向 但是 我尝试使用相同的方法来旋转已选择 设置的图像 但它不起作用 这是我正在使用的逻辑 import package i
  • SASS/SCSS @import 前面的 ~ 是什么意思/做什么?

    我在 GitHub 上被告知开始使用 在我的 SASS SCSS 之前 import路径 试图用谷歌搜索但找不到正确的答案 我想这太新手了 甚至懒得写 但我想学习它 它指的是node modules目录 或其等效目录 例如 在 Angula
  • 如何获取 Zune 中定义的设备名称?

    在 Zune 中 可以通过 Zune gt 设置 gt 手机 gt 同步选项更改手机名称 例如 我将手机名称更改为 myphone lumia 900 我怎样才能得到这个名字 使用DeviceStatus DeviceName它仅返回型号
  • Python IDLE 无法打开文件,显示“打开文件操作无法连接到打开和保存面板服务”

    刚刚升级到带有 m1 pro 芯片的新 MBP 我在尝试通过 IDLE 打开文件时遇到一些奇怪的问题 它抛出一个错误 说 打开文件操作无法连接到打开和保存面板服务 我尝试重新安装python 当在IDLE的服务设置下查看时 我找不到这样的服
  • 如何重命名 android-debug.apk

    我正在使用 Cordova 5 1 1 和 ionic 框架来创建我的 android 但是 当我尝试构建 apk 时 为什么文件名始终是 android debug apk 有什么办法可以重命名吗 cordova 创建 hello com
  • 如何在每个页面的侧边栏中包含目录树

    我正在 Sphinx 中生成 html 文档 如何修改文档中每个 html 页面的侧边栏 以便它们包含目录树 默认情况下 目录树似乎只显示在master doc页面 并且仅在主区域而不是侧边栏 是否有捷径可寻 我将使用 readthedoc