Add a warning directive at the top of every page on a Sphinx RTD site

Question

I'd like to add a simple warning directive at the top of every page on a Sphinx RTD site:

.. 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 someemail@someaddress.com!

What's the simplest way to do this? I'm using the sphinx_rtd_theme.

I can see how to add a block using the extrabody block, but it appears outside the main content area and is positioned and styled totally independently.

Ideally, I'd want this block to show up at an attention directive just below the breadcrumbs on every page.

user_3627580 · Answer

You could add this to the conf.py Sphinx configuration file:

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

and it will be included at the beginning of every source file that is read ‒ see https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_prolog.

F-string literals work too, so f'This is release #{release}' will substitute that variable value.

Add a warning directive at the top of every page on a Sphinx RTD site

1 Answers