在Sphinx RTD网站上每个页面的顶部添加警告指令

Question

我想在Sphinx RTD网站的每一页顶部添加一个简单的警告指令：

.. attention::

  The next major release of this project will launch on X date.
  In the meantime, we're looking for feedback.
  If you'd like an early preview, please reach out at [email protected]!

最简单的方法是什么？我正在使用sphinx_rtd_theme。

我可以看到如何使用extrabody块添加一个块，但是它出现在主要内容区域之外，并且完全独立地放置和设置样式。

理想情况下，我希望此代码块出现在每页面包屑下方的关注指令处。

Answer 1

您可以将其添加到conf.py Sphinx配置文件：

rst_prolog = """.. attention::
    The next major release is imminent.
"""

并且它将包含在每个读取的源文件的开头‒参见https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_prolog。

F字符串文字也可以使用，因此f'This is release #{release}'将替换该变量值。