RestructuredText文件中可能包含文本的私有部分？

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')