diff options
author | efiacor <fiachra.corcoran@est.tech> | 2022-10-25 11:46:34 +0100 |
---|---|---|
committer | Michael Morris <michael.morris@est.tech> | 2022-10-27 14:16:14 +0000 |
commit | 248a9f1c153333002df39567e33fd5fa6092a62b (patch) | |
tree | 4ce527613327984d9c7cb13108ab11fde8cea3f9 /docs/conf.py | |
parent | cb2663200092725c96240548e8fa046575530703 (diff) |
[SDC-DIST-CLIENT] Add new RTD entry
Update README etc
Signed-off-by: efiacor <fiachra.corcoran@est.tech>
Change-Id: I4f92684e82d3fc2df978af12100be0871b94178d
Issue-ID: DMAAP-1792
Diffstat (limited to 'docs/conf.py')
-rw-r--r-- | docs/conf.py | 55 |
1 files changed, 49 insertions, 6 deletions
diff --git a/docs/conf.py b/docs/conf.py index 5371015..80888b3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,15 +1,58 @@ -from docs_conf.conf import * +project = "onap" +release = "master" +version = "master" -branch = 'latest' -master_doc = 'index' +author = "Open Network Automation Platform" +# yamllint disable-line rule:line-length +copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License" -linkcheck_ignore = [ - 'http://localhost', +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' ] +exclude_patterns = ['archived/*.rst', '.tox'] +# +# 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' + +spelling_word_list_filename='spelling_wordlist.txt' +spelling_lang = "en_GB" + +# +# 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_stylesheet("css/ribbon.css") + app.add_css_file("css/ribbon.css") + + +linkcheck_ignore = [ + r'http://localhost:\d+/', + r'https:\/\/mvnrepository.com\/.*' +]
\ No newline at end of file |