Added output of build metadata to autogenerated documentation.

conf.py

@@ -22,10 +22,15 @@
 
 import os
 import sys
+import json
 
-#lib = os.path.abspath(os.path.join(os.path.dirname(__file__), './pyzenkit'))
-lib = os.path.abspath(os.path.dirname(__file__))
-sys.path.insert(0, lib)
+# -- Load custom metadata ------------------------------------------------------
+
+with open('metadata.json') as json_metadata_file:
+    custom_metadata = json.load(json_metadata_file)
+
+def setup(app):
+    app.add_config_value('build_suite', custom_metadata['suite'], 'env')
 
 # -- General configuration ------------------------------------------------
 
@@ -89,6 +94,14 @@ pygments_style = 'sphinx'
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
+rst_epilog = """
+.. |codename| replace:: **{codename}**
+.. |suite| replace:: *{suite}*
+.. |bversion| replace:: *{bversion}*
+.. |revision| replace:: ``{revision}``
+.. |bnumber| replace:: *- {bnumber}*
+""".format(**custom_metadata)
+
 
 # -- Options for HTML output ----------------------------------------------
 

doc/_doclib/api.rst

-.. _section-api:
+.. _section-api-pyzenkit:
 
 API
 ================================================================================

doc/_doclib/architecture.rst

+.. _section-pyzenkit-architecture:
+
 Application architecture
 ================================================================================
 

manual.rst

@@ -4,6 +4,14 @@
 Welcome to PyZenKit - Python script and daemon toolkit's documentation!
 ================================================================================
 
+.. note::
+
+    Please be aware, that this version of documentation is appropriate for:
+
+    * version:      |bversion|
+    * distribution: |codename| (|suite|)
+    * Git revision: |revision|
+
 .. warning::
 
     Although production code is based on this library, it should still be considered

metadata.json

+{"codename":"local","suite": "unstable","bversion":"unknown","revision":"latest","bnumber":"unknown"}