X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fconf.py;h=9541a9eff3392f8e3feb3dc95a6cc720665a82f7;hb=5ad4a8a03a275e81b379f7eba28731f789d9676b;hp=41f10d79b8bf8f32c93835412ad466cde9a00517;hpb=0f688a1c18055cea888f1a208303940271942356;p=opnfvdocs.git diff --git a/docs/conf.py b/docs/conf.py index 41f10d79b..9541a9eff 100644 --- 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,9 @@ 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 language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -101,7 +103,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 +266,7 @@ texinfo_documents = [ 'Miscellaneous'), ] +html_sidebars = {'**': ['localtoc.html', 'relations.html'],} # Documents to append as an appendix to all manuals. # texinfo_appendices = [] @@ -275,5 +279,6 @@ 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['releng'] = ('https://opnfv-releng.readthedocs.io/en/latest', None) +intersphinx_mapping['ovn4nfv'] = ('https://opnfv-ovn4nfv.readthedocs.io/en/latest', None)