# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
+import subprocess
import sys
import sphinx_bootstrap_theme
+
sys.path.insert(0, os.path.abspath('..'))
+
+def format_version(version):
+ fmt = '{tag}.dev{commitcount}+{gitsha}'
+ parts = version.split('-')
+ assert len(parts) in (3, 4)
+ dirty = len(parts) == 4
+ tag, count, sha = parts[:3]
+ if count == '0' and not dirty:
+ return tag
+ return fmt.format(tag=tag, commitcount=count, gitsha=sha.lstrip('g'))
+
+
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# built documents.
#
# The short X.Y version.
-version = '0.1'
+command = 'git describe --tags --long --dirty'
+try:
+ git_version = format_version(
+ subprocess.check_output(command.split()).decode('utf-8').strip())
+except subprocess.CalledProcessError: # Handle docs builds from tarball
+ git_version = "v0.0.9999-local"
+version = git_version
# The full version, including alpha/beta/rc tags.
release = version
# html_theme_options = {}
html_theme_options = {
'bootswatch_theme': "cerulean",
+ 'navbar_sidebarrel': False,
+ 'source_link_position': "footer",
}
# Add any paths that contain custom themes here, relative to this directory.
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
-# html_logo = None
+html_logo = '_static/lf-logo-small.png'
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
-# html_favicon = None
+html_favicon = 'favicon.ico'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# Custom sidebar templates, maps document names to template names.
#
-# html_sidebars = {}
+html_sidebars = {
+ '**': ['localtoc.html', 'relations.html'],
+}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
+ 'jjb': ('https://docs.openstack.org/infra/jenkins-job-builder/', None),
'lftools': ('http://lftools.releng.linuxfoundation.org/en/latest/', None),
'python': ('https://docs.python.org/', None),
}
-