diff options
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 68 |
1 files changed, 45 insertions, 23 deletions
diff --git a/docs/conf.py b/docs/conf.py index 29923a05..a9c42b67 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,34 +1,56 @@ -from docs_conf.conf import * +project = "onap" +release = "master" +version = "master" + +author = "Open Network Automation Platform" +# yamllint disable-line rule:line-length +copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License" + +pygments_style = "sphinx" +html_theme = "sphinx_rtd_theme" +html_theme_options = { + "style_nav_header_background": "white", + "sticky_navigation": "False" } +html_logo = "_static/logo_onap_2017.png" +html_favicon = "_static/favicon.ico" +html_static_path = ["_static"] +html_show_sphinx = False + +extensions = [ + 'sphinx.ext.intersphinx', + 'sphinx.ext.graphviz', + 'sphinxcontrib.blockdiag', + 'sphinxcontrib.seqdiag', + 'sphinxcontrib.swaggerdoc', + 'sphinxcontrib.plantuml' +] + +# +# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch. +# Change to {releasename} after you have created the new 'doc' branch. +# branch = 'latest' + +intersphinx_mapping = {} +doc_url = 'https://docs.onap.org/projects' master_doc = 'index' -linkcheck_ignore = [ - 'http://localhost', -] +exclude_patterns = ['.tox'] -extensions = ['sphinx_tabs.tabs', 'sphinxcontrib.redoc',] - -redoc = [ - { - 'name': 'PMS API', - 'page': 'offeredapis/pms-api', - 'spec': './offeredapis/swagger/pms-api.json', - 'embed': True, - }, - { - 'name': 'A1 ADAPTER API', - 'page': 'offeredapis/a1-adapter-api', - 'spec': './offeredapis/swagger/a1-adapter-api.json', - 'embed': True, - } - ] - -redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js' +spelling_word_list_filename='spelling_wordlist.txt' +spelling_lang = "en_GB" -intersphinx_mapping = {} +# +# Example: +# intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None) +# html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): app.add_css_file("css/ribbon.css") + +linkcheck_ignore = [ + r'http://localhost:\d+/' +] |