diff options
| -rw-r--r-- | docs/conf.py | 26 | ||||
| -rw-r--r-- | docs/conf.yaml | 7 | ||||
| -rw-r--r-- | etc/requirements-docs.txt | 4 |
3 files changed, 25 insertions, 12 deletions
diff --git a/docs/conf.py b/docs/conf.py index 77863e9fd..f8f70bbc1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,24 @@ -from docs_conf.conf import * +project = "onap" +release = "master" +version = "master" -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. @@ -11,6 +26,9 @@ intersphinx_mapping = {} # # latest|{releasename} +intersphinx_mapping = {} +doc_url = 'https://docs.onap.org/projects' +master_doc = 'index' branch = 'latest' 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) diff --git a/docs/conf.yaml b/docs/conf.yaml deleted file mode 100644 index ab5928131..000000000 --- a/docs/conf.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -project_cfg: onap -project: onap - -# Change this to ReleaseBranchName to modify the header -default-version: latest -# diff --git a/etc/requirements-docs.txt b/etc/requirements-docs.txt index cc2d12c20..dc55d67b4 100644 --- a/etc/requirements-docs.txt +++ b/etc/requirements-docs.txt @@ -1,6 +1,8 @@ -lfdocs-conf sphinx>=4.2.0 # BSD sphinx-rtd-theme>=1.0.0 # MIT +sphinxcontrib-blockdiag # BSD +sphinxcontrib-seqdiag # BSD +sphinxcontrib-swaggerdoc autopep8 sphinxcontrib-spelling pylint |