Python sphinx：忽略.rst文件中的文本

我在GitHub上有一个README.rst，它也被合并到Sphinx为Python项目生成的文档中。我想在文件顶部添加一个注释，该注释将显示在GitHub上（它只是呈现.rst），但不会显示在Sphinx生成的文档中

---

我知道我可以使用

在
.rst
文件中包含注释。。诸如此类的废话，但是有没有什么方法可以让我包含一行仅被斯芬克斯视为注释的内容？（或者，让Sphinx以其他方式忽略该行。）
您希望GitHub上包含的
.rst
文件中有一行，但在Sphinx文档中被忽略

可以通过使用
ifconfig
指令以这种方式实现

在
conf.py
文件中，检查
sphinx.ext.ifconfig
扩展名是否已启用

# conf.py
extensions = [
    ...
    'sphinx.ext.ifconfig',
    ...
]

并注册一个变量

# conf.py
# custom variables
def setup(app):
    app.add_config_value(name='show_github_hote', default=True, rebuild='env')

# uncomment in Sphinx doc to hide the note
# show_github_hote = False

然后在
.rst
文件中

.. ifconfig:: show_github_hote

    THIS NOTE IS FOR GITHUB ONLY.

    Use bigger indentation for the note.

Further text with smaller indent. 

如果未设置
show\u github\u hote
var，则默认值为
True
，并且应打印注释。要在sphinx的
conf.py
错误标记中隐藏注释集
show\u github\u hote=False
，您应该放置“python sphinx”谢谢！做出了更改。考虑到Sphinx和GitHub都将其解释为RST，我不明白如何在其中一个中包含注释，而在另一个中不包含注释。嗯，可以包含类似
的内容。。注意：：
在狮身人面像中做一些事情，但在普通RST中做不了多少。我想它不需要注释，我只希望Sphinx在最终生成的文档中不包含文本。