Add instructions on how to test script locally

[releng/global-jjb.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 99ff3e6..1be2051 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -67,7 +67,7 @@ author = 'Linux Foundation Releng'
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = '0.19.0-dev'
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -138,6 +138,8 @@ html_theme = 'bootstrap'
 # 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.
@@ -156,13 +158,13 @@ html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
 # 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,
@@ -188,7 +190,9 @@ html_static_path = ['_static']
 
 # 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.
@@ -251,7 +255,7 @@ htmlhelp_basename = 'LinuxFoundationReleaseEngineeringGJJBdoc'
 
 # 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),
 }
-