conditional-statements - RestructuredText 文件中可能包含文本的私有(private)部分？

Question

我正在将我公司的一些文档从 .md 转换为 .rst 以显示在 ReadTheDocs.com 中

在其中一些文档中，存在不适合我们客户使用的内部部分。

有没有办法标记这些部分，使 Sphinx 不会将其呈现为 HTML？

Answer 1

使用 ifconfig directive .

在您的文档中:

.. ifconfig:: internal

   This stuff is only included in the built docs for internal versions.

在您的conf.py 的setup 函数中:

def setup(app):
    app.add_config_value('internal', '', 'env')