doc: make latest release available as a variable inside docs

f3a3e73c · Dimitris Lampridis · c1da766f · f3a3e73c · f3a3e73c · f3a3e73c
Commit f3a3e73c authored Dec 16, 2022 by Dimitris Lampridis
Hide whitespace changes
Inline Side-by-side

Showing with 10 additions and 2 deletions

Makefile doc/Makefile +1 -1

conf.py doc/conf.py +8 -0

introduction.rst doc/introduction.rst +1 -1

No files found.
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -8,7 +8,7 @@

 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    = -Drelease=$(shell git describe) -Dversion=$(shell git describe | cut -d "-" -f 1 | tr -d "v")
+SPHINXOPTS    =
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build

--- a/doc/conf.py
+++ b/doc/conf.py
@@ -26,6 +26,11 @@ project = 'FMC-TDC 1ns 5cha'
 copyright = u'2022, CERN, documentation released under CC-BY-SA-4.0'
 author = 'Federico Vaga <federico.vaga@cern.ch>'

+import re
+
+release = os.popen('git describe --tags').read().strip()
+version = re.sub('^v', '', release.split('-')[0])
+
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
@@ -109,3 +114,6 @@ breathe_projects_source = {
 }

 breathe_default_project = "fmctdc-lib"
+
+# Will be appended to every rst source file in order to provide a reference to the latest version
+rst_epilog = '.. |latest_release| replace:: %s' % version
--- a/doc/introduction.rst
+++ b/doc/introduction.rst
@@ -28,7 +28,7 @@ here. You can clone the GIT project with the following command::

 Within the GIT respository, releases are marked with a TAG named
 using the `Semantic Versioning`_. For example the latest release is
-``v8.0.0``. You can also find older releases with a different versioning
+|latest_release|. You can also find older releases with a different versioning
 mechanism.

 For each release we will publish the FPGA bitstream for all supported