Question

我找不到处理此问题的指令。

假设有一个rst文档，并且出于某种原因，您希望在构建期间隐藏单个section（无论是html，pdf ..），如：

Visibile section
================
Here some example I want to show


Not visible section
===================
Some text that I have written but for the current build I want to hide from the final document

是否有.. hidden::指令来处理这个问题，我想的是：

Visibile section
================
Here some example I want to show

.. hideen::

Not visible section
===================
Some text that I have written but for the current build I want to hide from the final document

.. visible::

Another section
===============
Other visible section in both text and final document

感谢您的任何建议！

Answer 1

我获得的Sphinx版本会自动生成一个index.rst文件，其开始如下：

.. sphinx-quickstart on Sat Jun 22 15:48:19 2019.
   You can adapt this file completely to your liking, etc

它没有显示在文档中。您可以以两个点和一个空格开头的行，然后是您自己的文本，但两者都不显示。您需要确保创建的所有行都与第一行缩进。然后整个部分不会显示。还要确保该节之前和之后都有一个空行（除非它是文件中的第一节或最后一个节）

Answer 2

这是隐藏部分的解决方案，因此它不会显示在 HTML 输出中。但是，这不会影响构建。

我们的想法是使用 class 指令，这样就可以将 CSS 类分配给部分。在 CSS 中，您可以使用 display: none（或任何其他 CSS）定义类。

例如，它看起来像（注意标识）：

Visible section
================
Here some example I want to show

.. class:: hidden

   Not visible section
   ===================
   Some text that I have written but for the current build I want to hide from the final document

Another section
===============
Other visible section in both text and final document

在您的 css 中添加以下样式：

.hidden { display: none }

这是一个link，解释了如何将自定义 CSS 添加到 Sphinx。

在sphinx文档中隐藏单个部分

2 个答案: