Sphinx:强制在文档中的节之前添加小节

问题描述 投票:0回答:1

我想写一个文档页面,其中有类似的内容:

Title
*****

Introductory text

Subsection with more details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Details

Section 1
=========

Section 2
=========

不幸的是,这只会将具有更多细节的小节呈现为主要部分,所有后续部分都是小节。根据我的研究,这似乎是因为 Sphinx 没有固定的标题层次结构,而是只是解释 文档结构,根据其连续性来决定各个部分的内容(如https://www.sphinx-doc.org/en/master/usage/restructedtext/basics.html所示)。

我还尝试使用标题的上部标记来强制部分层次结构,但这似乎也不起作用。 有没有一种不太侵入性的方法来做到这一点?此页面适用于一个开源项目,已经有很多文档页面,并非所有页面都遵循相同的标记标准,而且我担心,如果我尝试在我们的设置中以某种方式定义每个部分/小节标记应该是什么样子,我们会我们面前有很多格式化问题......(或者我会,呵呵)

=========
Section 1
=========

提前致谢!

python-sphinx markup restructuredtext
1个回答
0
投票

Docutils

<section>
元素中没有“level”属性。子节嵌套在其父节内,节级别源自嵌套级别。

根据实际需要,您可以使用以下几种解决方法:

  • 重组文档以具有标准的章节布局。
  • 使用body元素为主文档大纲之外的材料提供标题(主题、侧边栏、标题)(即不应出现在目录中)。
  • 使用姐妹部分级别并使用自定义 CSS 对其进行样式设计。

示例:

Title
*****

Introductory text

.. rst-class:: details-section

Minor section with more details
===============================

Section 1
=========
...

以及自定义 CSS 规则,例如

.details-section h2 {font-size: large}

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