docs/conf: add important admonition to the prolog about f4pga utils

Signed-off-by: Unai Martinez-Corral <[email protected]>
f4pga · May 16, 2022 · 7e19522 · 7e19522
1 parent 058b84e
commit 7e19522
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -38,6 +38,16 @@
 
 pygments_style = 'default'
 
+rst_prolog = """
+.. IMPORTANT::
+  Since May 2022, packages providing Architecture Definition assets do *not* include CLI
+  utilities/wrappers to interact with Yosys, Verilog-to-Routing, etc.
+  For backwards compatibility, end-users can install Python package ``f4pga`` from
+  :gh:`chipsalliance/f4pga`.
+  For instance:
+  ``pip install https://github.com/chipsalliance/f4pga/archive/main.zip#subdirectory=f4pga``.
+"""
+
 todo_include_todos = False
 
 # -- Options for HTML output -----------------------------------------------------------------------