automatically use version number set by cmake in doc

70akaline · Mar 10, 2022 · 03c1af5 · 03c1af5
1 parent 6c94c72
commit 03c1af5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/doc/conf.py.in b/doc/conf.py.in
@@ -52,6 +52,13 @@ autosummary_imported_members=False
 project = 'TRIQS DFTTools'
 version = '@PROJECT_VERSION@'
 
+# this makes the current project version available as var in every rst file
+rst_epilog = """
+.. |PROJECT_VERSION| replace:: {version}
+""".format(
+version = version,
+)
+
 copyright = '2011-2021'
 
 mathjax_path = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=default"

diff --git a/doc/index.rst b/doc/index.rst
@@ -4,9 +4,9 @@
 DFTTools
 #########
 
-.. sidebar:: DFTTools 3.0.0
+.. sidebar:: DFTTools |PROJECT_VERSION|
 
-   This is the homepage of DFTTools v3.0.0.
+   This is the homepage of DFTTools |PROJECT_VERSION|
    For changes see the :ref:`changelog page <changelog>`.
 
       .. image:: _static/logo_github.png