diff options
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 120 |
1 files changed, 31 insertions, 89 deletions
diff --git a/docs/conf.py b/docs/conf.py index 5cab846ce..79b64b202 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,35 +1,22 @@ -# -*- coding: utf-8 -*- +#Copyright (c) 2017 Open Network Automation Platform and contributors # -# ONAP documentation build configuration file, created by -# sphinx-quickstart on Wed Jul 19 16:25:31 2017. +#Licensed under the Apache License, Version 2.0 (the "License"); +#you may not use this file except in compliance with the License. +#You may obtain a copy of the License at # -# This file is execfile()d with the current directory set to its -# containing dir. +# http://www.apache.org/licenses/LICENSE-2.0 # -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex -#import sphinx_bootstrap_theme - -# 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 -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +#Unless required by applicable law or agreed to in writing, +#software distributed under the License is distributed on an +#"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, +#either express or implied. See the License for the specific +#language governing permissions and limitations under the License. -# -- General configuration ------------------------------------------------ +import sphinx_bootstrap_theme +from docs_conf.conf import * -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '1.5.3' -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. +#Sphinx Extensions extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.doctest', @@ -47,81 +34,42 @@ extensions = [ 'sphinxcontrib.swaggerdoc' ] -# Font path for seqdiag +# Extension Configuration seqdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf' nwdiag_fontpath = '/usr/share/fonts/truetype/dejavu/DejaVuSansCondensed.ttf' -# Add any paths that contain templates here, relative to this directory. +# Template Paths templates_path = ['_templates'] # The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] source_suffix = '.rst' -# The encoding of source files. -#source_encoding = 'utf-8-sig' - # The master toctree document. master_doc = 'index' # General information about the project. project = u'' copyright = u'2019 ONAP. Licensed under Creative Commons Attribution 4.0 International License' - - author = u'Open Network Automation Platform' -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# The short X.Y version. -version = 'master branch' -# The full version, including alpha/beta/rc tags. -release = 'master branch' +# Project version and release +version = 'dublin' +release = 'dublin' -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. +# The language for content autogenerated by Sphinx. language = None -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [ '_build' ] -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +keep_warnings = True # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True @@ -129,21 +77,13 @@ todo_include_todos = True # -- Options for HTML output ---------------------------------------------- -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -#html_theme = 'classic' -html_theme = 'sphinx_rtd_theme' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. +# The theme to use for HTML and HTML Help pages. +html_theme = 'bootstrap' html_theme_options = { - 'style_nav_header_background': 'white', - 'sticky_navigation': False + 'bootswatch_theme': "lumen", + 'navbar_sidebarrel': False } - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() +html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". @@ -155,10 +95,6 @@ html_theme_options = { # The name of an image file (relative to this directory) to place at the top # of the sidebar. html_logo = '_static/logo_onap_2017.png' - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. html_favicon = '_static/favicon.ico' # Add any paths that contain custom static files (such as style sheets) here, @@ -380,6 +316,12 @@ epub_exclude_files = ['search.html'] # If false, no index is generated. #epub_use_index = True + +nitpicky = True +html_context = { + 'version_status': 'supported', + } + # Patterns to ignore in linkcheck builder linkcheck_ignore = [ r'http://$', |