Add date and git information to version
authorJan Dittberner <jandd@cacert.org>
Wed, 14 Feb 2018 17:12:59 +0000 (18:12 +0100)
committerJan Dittberner <jandd@cacert.org>
Wed, 14 Feb 2018 17:12:59 +0000 (18:12 +0100)
This commit adds git version information and a UTC timestamp to the
version information. Copyright information has been updated.

doc-requirements.txt
docs/conf.py

index e317d52..7752ffe 100644 (file)
@@ -13,3 +13,4 @@ jandd.sphinxext.ip==0.2.4
 jandd.sphinxext.mac==0.1.0
 py-dateutil==2.2
 validate-email==1.3
 jandd.sphinxext.mac==0.1.0
 py-dateutil==2.2
 validate-email==1.3
+GitPython==2.1.8
index d612007..dcc539f 100644 (file)
 
 import sys
 import os
 
 import sys
 import os
+from datetime import datetime
 from urllib.parse import urljoin
 from urllib.parse import urljoin
+
+from git import repo
 from docutils import nodes, utils
 
 # If extensions (or modules to document with autodoc) are in another directory,
 from docutils import nodes, utils
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -54,8 +57,8 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'CAcert infrastructure'
 
 # General information about the project.
 project = u'CAcert infrastructure'
-copyright = u'2016, Jan Dittberner'
-author = u'Jan Dittberner'
+copyright = u'2016, 2017, 2018 Jan Dittberner, CAcert'
+author = u'CAcert infrastructure team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -64,7 +67,10 @@ author = u'Jan Dittberner'
 # The short X.Y version.
 version = u'0.1'
 # The full version, including alpha/beta/rc tags.
 # The short X.Y version.
 version = u'0.1'
 # The full version, including alpha/beta/rc tags.
-release = u'0.1'
+release = "{}-git:{} built:{}".format(
+        version,
+        repo.Repo('..').git.describe('--always', '--dirty'),
+        datetime.utcnow().replace(microsecond=0))
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.