From 4d8d07ec6fd236b3c3d07b46b95855e212ae0913 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Thu, 7 Jul 2022 10:05:18 +0200 Subject: format conf.py; fix link in setup guide; fix releaserepos (jakarta) Issue-ID: DOC-782 Signed-off-by: thmsdt Change-Id: Ie501f5ff3bddac7d53a0dfcdca79e50b5f032f31 --- docs/conf.py | 29 ++++++++++++++++++---- .../how-to-use-docs/setting-up-environment.rst | 2 +- docs/release/releaserepos.rst | 8 +++++- 3 files changed, 32 insertions(+), 7 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 6748bcb97..41055b067 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,17 +1,36 @@ -from docs_conf.conf import * +project = "onap" +release = "jakarta" +version = "jakarta" -doc_url = 'https://docs.onap.org/projects' -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." -intersphinx_mapping = {} +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','sphinxcontrib.blockdiag', + 'sphinxcontrib.seqdiag', 'sphinxcontrib.swaggerdoc', 'sphinx.ext.graphviz'] # # Map to 'latest' if this file is used in 'latest' (master) 'doc' branch. # Change to {releasename} after you have created the new 'doc' branch. # -# latest|{releasename} branch = 'jakarta' + +intersphinx_mapping = {} +doc_url = 'https://docs.onap.org/projects' +master_doc = 'index' + intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None) diff --git a/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst b/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst index c3f52e895..341279b99 100644 --- a/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst +++ b/docs/guides/onap-developer/how-to-use-docs/setting-up-environment.rst @@ -13,7 +13,7 @@ Prerequisites ~~~~~~~~~~~~~ Before you start, you should have an LFID account (sign up -`here `_). +`here `_). Installing git ~~~~~~~~~~~~~~ diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index d87485ff2..f7086446f 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -25,6 +25,10 @@ CCSDK - Common Controller Software Development Kit - :ref:`ccsdk/distribution ` - :ref:`ccsdk/oran ` +CLI - Command Line Interface +---------------------------- +- :ref:`cli ` + CPS - Configuration Persistence Service --------------------------------------- - :ref:`cps ` @@ -68,7 +72,9 @@ MULTICLOUD - Multi Cloud OOF - Optimization Framework ---------------------------- -- :doc:`optf/has ` + +.. - :ref:`optf/has ` ### anchor missing in jakarta release + - :ref:`optf/osdf ` OOM - ONAP Operations Manager -- cgit 1.2.3-korg