mirror of
https://github.com/gnif/LookingGlass.git
synced 2024-11-09 16:18:20 +00:00
[doc] automatically detect version
We prefer the VERSION file if available, otherwise falling back to querying version directly from git.
This commit is contained in:
parent
6f8745a89b
commit
4dccd725bf
15
doc/conf.py
15
doc/conf.py
@ -5,6 +5,7 @@
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
from pathlib import Path
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
@ -22,7 +23,19 @@ copyright = '2021, Looking Glass team'
|
||||
author = 'Geoffrey McRae and the Looking Glass team'
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = 'B4'
|
||||
try:
|
||||
with open(Path(__file__).parent.parent / 'VERSION') as f:
|
||||
release = f.read().strip()
|
||||
except IOError:
|
||||
import subprocess
|
||||
try:
|
||||
release = subprocess.check_output([
|
||||
'gist', 'describe', '--always', '--abbrev=10', '--dirty=+', '--tags'
|
||||
]).decode('utf-8').strip()
|
||||
except (subprocess.CalledProcessError, OSError):
|
||||
release = '(unknown version)'
|
||||
del subprocess
|
||||
|
||||
|
||||
rst_prolog = """
|
||||
.. |license| replace:: GPLv2
|
||||
|
Loading…
Reference in New Issue
Block a user