RestructuredText文件中可能存在文本的私人部分？ [英] Private sections of text possible in RestructuredText files?

问题描述

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

I'm in the process of converting some of my company's documentation from .md to .rst to be displayed in ReadTheDocs.com

在某些文档中

是否可以标记这些部分，以使Sphinx不会将其呈现为HTML？

Is there a way to mark these sections such that Sphinx doesn't render it into HTML?

推荐答案

使用 ifconfig 指令。

在您的文档中：

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

这篇关于RestructuredText文件中可能存在文本的私人部分？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！