diff options
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/sphinx/master/conf.py | 5 | ||||
| -rw-r--r-- | examples/sphinx/master/requirements-docs.txt | 2 | ||||
| -rw-r--r-- | examples/sphinx/master/spelling_wordlist.txt | 10 | ||||
| -rw-r--r-- | examples/sphinx/master/tox.ini | 76 | ||||
| -rw-r--r-- | examples/sphinx/release/_static/css/ribbon.css | 122 | ||||
| -rw-r--r-- | examples/sphinx/release/conf.py | 11 | ||||
| -rw-r--r-- | examples/sphinx/release/requirements-docs.txt | 2 | ||||
| -rw-r--r-- | examples/sphinx/release/spelling_wordlist.txt | 10 | ||||
| -rw-r--r-- | examples/sphinx/release/tox.ini | 76 |
9 files changed, 124 insertions, 190 deletions
diff --git a/examples/sphinx/master/conf.py b/examples/sphinx/master/conf.py index a4823355e..d447769b9 100644 --- a/examples/sphinx/master/conf.py +++ b/examples/sphinx/master/conf.py @@ -31,6 +31,11 @@ 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) diff --git a/examples/sphinx/master/requirements-docs.txt b/examples/sphinx/master/requirements-docs.txt index dc55d67b4..ed96b42b7 100644 --- a/examples/sphinx/master/requirements-docs.txt +++ b/examples/sphinx/master/requirements-docs.txt @@ -3,6 +3,4 @@ sphinx-rtd-theme>=1.0.0 # MIT sphinxcontrib-blockdiag # BSD sphinxcontrib-seqdiag # BSD sphinxcontrib-swaggerdoc -autopep8 sphinxcontrib-spelling -pylint diff --git a/examples/sphinx/master/spelling_wordlist.txt b/examples/sphinx/master/spelling_wordlist.txt new file mode 100644 index 000000000..35c04686f --- /dev/null +++ b/examples/sphinx/master/spelling_wordlist.txt @@ -0,0 +1,10 @@ +Goodger +Mär +docinfo +overlined +Docutils +csv +sectnum +reST +unicode +defs diff --git a/examples/sphinx/master/tox.ini b/examples/sphinx/master/tox.ini index 6505b8512..3c27e3610 100644 --- a/examples/sphinx/master/tox.ini +++ b/examples/sphinx/master/tox.ini @@ -1,77 +1,31 @@ [tox] minversion = 1.6 -envlist = docs,docs-linkcheck +envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true [testenv:docs] basepython = python3 deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt + -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 ./docs/ {toxinidir}/docs/_build/html - echo "Generated docs available in {toxinidir}/docs/_build/html" -whitelist_externals = - echo - git - sh - -[testenv:docs-templates] -basepython = python3 -deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt -commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs ./docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/docs/_build/html/templates - echo "Generated docs available in {toxinidir}/docs/_build/html/templates" -whitelist_externals = - echo - -[testenv:local] -basepython = python3 -deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt -commands = - git submodule update --depth 100 --init - sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html - echo "Generated docs available in {toxinidir}/docs/_build/html" -whitelist_externals = - echo - git + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html [testenv:docs-linkcheck] basepython = python3 deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt -commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck - -[testenv:spellcheck] -basepython = python3 -deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt + -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 -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck + sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck -[testenv:autopep8] -deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt -commands = - autopep8 --max-line-length 120 --in-place docs/conf.py - -[testenv:pylint] +[testenv:docs-spellcheck] +basepython = python3 deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt + -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 = - pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py + sphinx-build -W -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck diff --git a/examples/sphinx/release/_static/css/ribbon.css b/examples/sphinx/release/_static/css/ribbon.css index d03a26b20..afb9480d6 100644 --- a/examples/sphinx/release/_static/css/ribbon.css +++ b/examples/sphinx/release/_static/css/ribbon.css @@ -1,63 +1,63 @@ .ribbon { - z-index: 1000; - background-color: #a00; - overflow: hidden; - white-space: nowrap; - position: fixed; - top: 25px; - right: -50px; - -webkit-transform: rotate(45deg); - -moz-transform: rotate(45deg); - -ms-transform: rotate(45deg); - -o-transform: rotate(45deg); - transform: rotate(45deg); - -webkit-box-shadow: 0 0 10px #888; - -moz-box-shadow: 0 0 10px #888; - box-shadow: 0 0 10px #888; - - } - - .ribbon a { - border: 1px solid #faa; - color: #fff; - display: block; - font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif; - margin: 1px 0; - padding: 10px 50px; - text-align: center; - text-decoration: none; - text-shadow: 0 0 5px #444; - transition: 0.5s; - } - - .ribbon a:hover { - background: #c11; - color: #fff; - } - - - /* override table width restrictions */ - @media screen and (min-width: 767px) { - - .wy-table-responsive table td, .wy-table-responsive table th { - /* !important prevents the common CSS stylesheets from overriding - this as on RTD they are loaded after this stylesheet */ - white-space: normal !important; + z-index: 1000; + background-color: #a00; + overflow: hidden; + white-space: nowrap; + position: fixed; + top: 25px; + right: -50px; + -webkit-transform: rotate(45deg); + -moz-transform: rotate(45deg); + -ms-transform: rotate(45deg); + -o-transform: rotate(45deg); + transform: rotate(45deg); + -webkit-box-shadow: 0 0 10px #888; + -moz-box-shadow: 0 0 10px #888; + box-shadow: 0 0 10px #888; + +} + +.ribbon a { + border: 1px solid #faa; + color: #fff; + display: block; + font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif; + margin: 1px 0; + padding: 10px 50px; + text-align: center; + text-decoration: none; + text-shadow: 0 0 5px #444; + transition: 0.5s; +} + +.ribbon a:hover { + background: #c11; + color: #fff; +} + + +/* override table width restrictions */ +@media screen and (min-width: 767px) { + + .wy-table-responsive table td, .wy-table-responsive table th { + /* !important prevents the common CSS stylesheets from overriding + this as on RTD they are loaded after this stylesheet */ + white-space: normal !important; + } + + .wy-table-responsive { + overflow: visible !important; + } +} + +@media screen and (max-width: 767px) { + .wy-table-responsive table td { + white-space: nowrap; } - - .wy-table-responsive { - overflow: visible !important; - } - } - - @media screen and (max-width: 767px) { - .wy-table-responsive table td { - white-space: nowrap; - } - } - - /* fix width of the screen */ - - .wy-nav-content { - max-width: 800px; - }
\ No newline at end of file +} + +/* fix width of the screen */ + +.wy-nav-content { + max-width: 800px; +} diff --git a/examples/sphinx/release/conf.py b/examples/sphinx/release/conf.py index b2ba93216..f85f8991d 100644 --- a/examples/sphinx/release/conf.py +++ b/examples/sphinx/release/conf.py @@ -1,6 +1,6 @@ project = "onap" -release = "kohn" -version = "kohn" +release = "{release}" +version = "{release}" author = "Open Network Automation Platform" # yamllint disable-line rule:line-length @@ -25,12 +25,17 @@ extensions = [ # Change to {releasename} after you have created the new 'doc' branch. # -branch = 'kohn' +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) diff --git a/examples/sphinx/release/requirements-docs.txt b/examples/sphinx/release/requirements-docs.txt index dc55d67b4..ed96b42b7 100644 --- a/examples/sphinx/release/requirements-docs.txt +++ b/examples/sphinx/release/requirements-docs.txt @@ -3,6 +3,4 @@ sphinx-rtd-theme>=1.0.0 # MIT sphinxcontrib-blockdiag # BSD sphinxcontrib-seqdiag # BSD sphinxcontrib-swaggerdoc -autopep8 sphinxcontrib-spelling -pylint diff --git a/examples/sphinx/release/spelling_wordlist.txt b/examples/sphinx/release/spelling_wordlist.txt new file mode 100644 index 000000000..35c04686f --- /dev/null +++ b/examples/sphinx/release/spelling_wordlist.txt @@ -0,0 +1,10 @@ +Goodger +Mär +docinfo +overlined +Docutils +csv +sectnum +reST +unicode +defs diff --git a/examples/sphinx/release/tox.ini b/examples/sphinx/release/tox.ini index 6505b8512..87f60aa2d 100644 --- a/examples/sphinx/release/tox.ini +++ b/examples/sphinx/release/tox.ini @@ -1,77 +1,31 @@ [tox] minversion = 1.6 -envlist = docs,docs-linkcheck +envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true [testenv:docs] basepython = python3 deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt + -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={release} commands = - sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html - echo "Generated docs available in {toxinidir}/docs/_build/html" -whitelist_externals = - echo - git - sh - -[testenv:docs-templates] -basepython = python3 -deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt -commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs ./docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/docs/_build/html/templates - echo "Generated docs available in {toxinidir}/docs/_build/html/templates" -whitelist_externals = - echo - -[testenv:local] -basepython = python3 -deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt -commands = - git submodule update --depth 100 --init - sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html - echo "Generated docs available in {toxinidir}/docs/_build/html" -whitelist_externals = - echo - git + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html [testenv:docs-linkcheck] basepython = python3 deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt -commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck - -[testenv:spellcheck] -basepython = python3 -deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt + -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={release} commands = - sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck + sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck -[testenv:autopep8] -deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt -commands = - autopep8 --max-line-length 120 --in-place docs/conf.py - -[testenv:pylint] +[testenv:docs-spellcheck] +basepython = python3 deps = - -r{toxinidir}/etc/requirements-docs.txt - -c{toxinidir}/etc/upper-constraints.os.txt - -c{toxinidir}/etc/upper-constraints.onap.txt + -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={release} commands = - pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py + sphinx-build -W -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck |