Update git submodules

[opnfvdocs.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 41f10d7..08b1d6f 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,4 +1,5 @@
 import sphinx_bootstrap_theme
+import os
 
 # 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
@@ -12,7 +13,8 @@ needs_sphinx = '1.3'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc',
-              'sphinx.ext.viewcode', 'sphinx.ext.napoleon']
+              'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
+              'sphinx.ext.intersphinx']
 # Disable javasphinx generation until we have a solution to long build
 # times. readthedocs timesout after 902 seconds.
 
@@ -31,7 +33,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = 'Documentation'
+project = ''
 copyright = '2017, OPNFV. Licensed under CC BY 4.0'
 author = 'Open Platform for NFV'
 
@@ -40,9 +42,14 @@ author = 'Open Platform for NFV'
 # built documents.
 #
 # The short X.Y version.
-version = 'Colorado'
+version = 'Latest'
 # The full version, including alpha/beta/rc tags.
-release = 'Colorado'
+release = 'Latest'
+# The branch this project should link against for projects
+# following the stable-branch process. On the opnfvdocs stable branch
+# this should be set to 'stable/<release>' where '<release>' is the
+# current stable release (Ex: 'stable/gambia')
+branch = 'latest'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -101,7 +108,8 @@ html_theme = 'bootstrap'
 # documentation.
 # html_theme_options = {}
 html_theme_options = {
-    'bootswatch_theme': "united",
+    'bootswatch_theme': "journal",
+    'navbar_sidebarrel': False,
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -263,6 +271,7 @@ texinfo_documents = [
      'Miscellaneous'),
 ]
 
+html_sidebars = {'**': ['localtoc.html', 'relations.html'],}
 # Documents to append as an appendix to all manuals.
 # texinfo_appendices = []
 
@@ -275,5 +284,12 @@ texinfo_documents = [
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 # texinfo_no_detailmenu = False
 
-# intersphinx_mapping =
-# {'RTD':('http://opnfvdocsdemo.readthedocs.io/projects/', None)}
+intersphinx_mapping = {}
+intersphinx_mapping['armband'] = ('https://opnfv-armband.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['copper'] = ('https://opnfv-copper.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['moon'] = ('https://opnfv-moon.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['netready'] = ('https://opnfv-netready.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['releng'] = ('https://opnfv-releng.readthedocs.io/en/latest', None)
+intersphinx_mapping['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['fuel'] = ('https://opnfv-fuel.readthedocs.io/en/%s' % branch, None)
+intersphinx_mapping['auto'] = ('https://opnfv-auto.readthedocs.io/en/%s' % branch, None)