Skip to content

Commit

Permalink
[doc] Update version in website sidebar
Browse files Browse the repository at this point in the history
  • Loading branch information
Wentzell committed Sep 1, 2023
1 parent e585766 commit 2c22ab8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
14 changes: 11 additions & 3 deletions doc/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ import sys
sys.path.insert(0, "@CMAKE_CURRENT_SOURCE_DIR@/sphinxext")
sys.path.insert(0, "@CMAKE_CURRENT_SOURCE_DIR@/sphinxext/numpydoc")

# exclude these folders from scanning by sphinx
exclude_patterns = ['_templates']

extensions = ['sphinx.ext.autodoc',
'sphinx.ext.mathjax',
'sphinx.ext.intersphinx',
Expand Down Expand Up @@ -44,16 +47,21 @@ source_suffix = '.rst'

project = 'TPRF - Two-Particle Response Function tool box for TRIQS'

project = '@PROJECT_NAME@'
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 = '2017, H. U.R. Strand'

mathjax_path = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=default"
templates_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_templates']

# exclude these folders from scanning by sphinx
exclude_patterns = ['_templates']

# this requires the sphinx_rtd_theme to be installed via pip
html_theme = 'sphinx_rtd_theme'
# this loads the custom css file to change the page width
Expand Down
4 changes: 2 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
The Two-Particle Response Function tool box (TPRF)
==================================================

.. sidebar:: tprf 3.0.0
.. sidebar:: tprf |PROJECT_VERSION|

This is the homepage of tprf v3.0.0
This is the homepage of tprf |PROJECT_VERSION|
For changes see, Cf :ref:`changelog page <changelog>`

.. image:: _static/logo_github.png
Expand Down

0 comments on commit 2c22ab8

Please sign in to comment.