Updates to how-to use documentation for linkcheck and spellcheck
Initial list of validword exceptions for immediate use of tox -espellcheck
Validword exceptions will be improved when DOC-262 is complete
Corrections of RST references based on recent Beijing contributions
Change-Id: Ic82de1088fd961c2ad91493e8736777aede1cdb1
Signed-off-by: Rich Bennett <rb2745@att.com>
Issue-ID: DOC-94
:titlesonly:
AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
:titlesonly:
AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
- DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/message-router/message-router.rst>
+ DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
------------------
GIT is a powerful tool allowing many actions, but without respecting some rules
------------------
GIT is a powerful tool allowing many actions, but without respecting some rules
-the GIT structure can be quickly ugly and unmaintaible.
+the GIT structure can be quickly ugly and unmaintainble.
Here are some conventions about GIT branches:
- ALWAYS create a local branch to edit or create any file. This local branch
Here are some conventions about GIT branches:
- ALWAYS create a local branch to edit or create any file. This local branch
git clone http://gerrit.onap.org/r/doc
git clone http://gerrit.onap.org/r/doc
-Update submodules, build documentation using tox & then open using any browser.
+Build documentation using tox local environment & then open using any browser.
firefox docs/_build/html/index.html
.. note:: Make sure to run `tox -elocal` and not just `tox`.
firefox docs/_build/html/index.html
.. note:: Make sure to run `tox -elocal` and not just `tox`.
+
+There are additional tox enviornment options for checking External URLs and Spelling.
+Use the tox environment options below and then look at the output with the Linux `more` or
+similar command for scanning for output that applies to the files you
+are validating.
+
+.. code-block:: bash
+
+ tox -elinkcheck
+ more < docs/_build/linkcheck/output.txt
+
+ tox -espellcheck
+ more < docs/_build/spellcheck/output.txt
+
:maxdepth: 1
:titlesonly:
:maxdepth: 1
:titlesonly:
- CLAMP - :ref:`Closed Loop Automation Platform<index-clamp-installation>`
+ CLAMP - Closed Loop Automation Platform<../../../submodules/clamp.git/docs/index.rst>
SDC - Service Design and Creation <../../../submodules/sdc.git/docs/installation.rst>
Use-Case UI <../../../submodules/usecase-ui.git/docs/platform/installation.rst>
VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/installation.rst>
SDC - Service Design and Creation <../../../submodules/sdc.git/docs/installation.rst>
Use-Case UI <../../../submodules/usecase-ui.git/docs/platform/installation.rst>
VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/installation.rst>
:maxdepth: 1
:titlesonly:
:maxdepth: 1
:titlesonly:
- APPC - Application Controller <../../../submodules/appc/deployment.git/docs/APPC%20Deployment%20Guidelines/APPC%20Deployment%20Guidelines.rst>
+ APPC - Application Controller <../../../submodules/appc/deployment.git/docs/APPC Deployment Guidelines/APPC Deployment Guidelines.rst>
DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/installation.rst>
Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/installation.rst>
Policy <../../../submodules/policy/engine.git/docs/platform/installation.rst>
DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/installation.rst>
Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/installation.rst>
Policy <../../../submodules/policy/engine.git/docs/platform/installation.rst>
:maxdepth: 1
:titlesonly:
:maxdepth: 1
:titlesonly:
- dmaap/messagerouter/messageservice<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes.rst>
+ dmaap/messagerouter/messageservice<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes/release-notes.rst>
External API / NBI
------
External API / NBI
------
--- /dev/null
+AAF
+AAI
+Alcatel
+amsterdam
+Ansible
+API
+APIs
+APPC
+ASCII
+Avro
+BPMN
+Camunda
+Cask
+Cassandra
+CCSDK
+CD
+CDAP
+cdrom
+ceilometer
+Ceilometer
+CentOS
+Ceph
+CI
+CLI
+Cloudify
+committer
+committers
+CommonMark
+Contrail
+CPU
+CSIT
+ONAP
-[testenv:docs-linkcheck]
deps = -r{toxinidir}/etc/requirements.txt
commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
deps = -r{toxinidir}/etc/requirements.txt
commands = sphinx-build -j 4 -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+
+[testenv:spellcheck]
+deps =
+ -r{toxinidir}/etc/requirements.txt
+ sphinxcontrib-spelling
+commands =
+ sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -Dspelling_word_list_filename=validwords.txt -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck