docs/conf: add admonition in the prolog, pointing to F4PGA

Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
This commit is contained in:
Unai Martinez-Corral 2022-04-08 12:26:02 +02:00
parent 8207c3e0dd
commit 56a7deeb5d
1 changed files with 6 additions and 0 deletions

View File

@ -61,6 +61,12 @@ templates_path = ['_templates']
# This pattern also affects html_static_path and html_extra_path. # This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
rst_prolog = """
.. IMPORTANT::
SymbiFlow is now F4PGA. See `f4pga.org <https://f4pga.org/>`__, `f4pga.readthedocs.io <https://f4pga.readthedocs.io>`__
and `f4pga-examples.readthedocs.io <https://f4pga-examples.readthedocs.io>`__.
"""
# -- Options for HTML output ---------------------------------------------------------------------- # -- Options for HTML output ----------------------------------------------------------------------
html_show_sourcelink = True html_show_sourcelink = True