相关疑难解决方法(0)

在"阅读文档"侧栏中显示整个toctree

我的理解是新的Read The Docs主题从toctree生成侧边栏,深度为2.我的文档相对较深,深度为2并不足以使其有用.如何增加此限制,或者最好将其完全删除?

如果这不合理,我怎样才能使用本地ToC而不是全局toctree?

python python-sphinx read-the-docs

12
推荐指数
1
解决办法
5317
查看次数

如何使用Sphinx创建不会出现在toctree中的标题?

我正在使用 Sphinx 为 Python 模块创建文档。

我想在页面上添加字幕,但我不希望它们出现在toctree 中

我想要小节和简短的(几行)描述。将每个部分标题添加到目录树会使浏览文档变得更加困难。

这是我的index.rst

Welcome to ModernGL's documentation!
====================================

.. figure:: Examples/images/02_uniforms_and_attributes.png
    :scale: 50 %
    :alt: ModernGL
    :align: center
    :figclass: align-center

Start `here <ModernGL.html>`_.

.. toctree::
    :maxdepth: 4
    :caption: Contents:

    ModernGL <ModernGL.rst>
    Examples <Examples.rst>
    Contributing <Contributing.rst>


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Run Code Online (Sandbox Code Playgroud)

我想添加一些字幕:

Subtitle 1
**********

Subtitle 2
**********

Subtitle 3
**********

Subtitle 4
**********
Run Code Online (Sandbox Code Playgroud)

我检查了文档,但不知道应该使用哪种类型的下划线。不确定是否有特殊的下划线将标题转换为 a<h4><h5>

使用 github README.md添加更多# …

python python-sphinx toctree

5
推荐指数
2
解决办法
4166
查看次数

标签 统计

python ×2

python-sphinx ×2

read-the-docs ×1

toctree ×1