diff options
author | Guangrong Fu <fu.guangrong@zte.com.cn> | 2022-10-27 14:29:26 +0800 |
---|---|---|
committer | Guangrong Fu <fu.guangrong@zte.com.cn> | 2022-10-27 15:49:08 +0800 |
commit | d35a5c85128c02d70843d8e90e3567cf37336151 (patch) | |
tree | fd69b5a052a8413995c3a86a03adf48cefa26009 /docs | |
parent | e17ef2e9010d5189f6cac83e44ebe2c7115f523d (diff) |
Updated doc configs
Issue-ID: HOLMES-582
Signed-off-by: Guangrong Fu <fu.guangrong@zte.com.cn>
Change-Id: Ia9ffb8965998238b4a3cef0955bad8d7428d1026
Diffstat (limited to 'docs')
-rw-r--r-- | docs/_static/css/ribbon.css | 4 | ||||
-rw-r--r-- | docs/conf.py | 61 | ||||
-rw-r--r-- | docs/conf.yaml | 7 | ||||
-rw-r--r-- | docs/requirements-docs.txt | 7 | ||||
-rw-r--r-- | docs/tox.ini | 31 |
5 files changed, 89 insertions, 21 deletions
diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css index 6008cb1..7342cdc 100644 --- a/docs/_static/css/ribbon.css +++ b/docs/_static/css/ribbon.css @@ -59,5 +59,5 @@ /* fix width of the screen */ .wy-nav-content { - max-width: none; -} + max-width: 800px; +}
\ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index db098a7..bf9f0d6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,19 +1,56 @@ -from docs_conf.conf import * - +project = "onap" release = "master" version = "master" - -branch = 'latest' -master_doc = 'index' - -linkcheck_ignore = [ - 'http://localhost', + +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' + +exclude_patterns = ['.tox'] + +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_css_file("css/ribbon.css") + +linkcheck_ignore = [ + r'http://localhost:\d+/' +]
\ No newline at end of file diff --git a/docs/conf.yaml b/docs/conf.yaml deleted file mode 100644 index ab59281..0000000 --- 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/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..ba3e0ec --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,7 @@ +sphinx>=4.2.0 # BSD +sphinx-rtd-theme>=1.0.0 # MIT +sphinxcontrib-blockdiag # BSD +sphinxcontrib-seqdiag # BSD +sphinxcontrib-swaggerdoc +sphinxcontrib-spelling +sphinxcontrib-plantuml
\ No newline at end of file diff --git a/docs/tox.ini b/docs/tox.ini new file mode 100644 index 0000000..44ea131 --- /dev/null +++ b/docs/tox.ini @@ -0,0 +1,31 @@ +[tox] +minversion = 1.6 +envlist = docs,docs-linkcheck,docs-spellcheck +skipsdist = true + +[testenv:docs] +basepython = python3.8 +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master +commands = + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html + +[testenv:docs-linkcheck] +basepython = python3.8 +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master +commands = + sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck + +[testenv:docs-spellcheck] +basepython = python3.8 +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master +commands = + sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck
\ No newline at end of file |