Add tox environment for spellcheck

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

diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index 01049c1..34dc24e 100644 (file)
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -47,7 +47,7 @@ Common Services
    :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>

diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
index fb32a3e..28c7aeb 100644 (file)
--- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst
@@ -205,7 +205,7 @@ About GIT branches
 ------------------
 
 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
@@ -421,7 +421,7 @@ Download the DOC repository.
 
    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.
 
 .. code-block:: bash
 
@@ -430,3 +430,17 @@ Update submodules, build documentation using tox & then open using any browser.
    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
+

diff --git a/docs/guides/onap-developer/settingup/components.rst b/docs/guides/onap-developer/settingup/components.rst
index ec8b561..129a6c0 100644 (file)
--- a/docs/guides/onap-developer/settingup/components.rst
+++ b/docs/guides/onap-developer/settingup/components.rst
@@ -18,7 +18,7 @@ User Interfaces
    :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>
@@ -30,7 +30,7 @@ Platform Components
    :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>

diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst
index a69a0a5..74fb45d 100644 (file)
--- a/docs/release/releaserepos.rst
+++ b/docs/release/releaserepos.rst
@@ -79,7 +79,7 @@ Data Management as a Platform Message Router
    :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
 ------

diff --git a/docs/validwords.txt b/docs/validwords.txt
new file mode 100644 (file)
index 0000000..b9c90bb
--- /dev/null
+++ b/docs/validwords.txt
@@ -0,0 +1,32 @@
+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

diff --git a/tox.ini b/tox.ini
index a352018..d94b112 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -20,6 +20,13 @@ whitelist_externals =
     echo
     git
 
-[testenv:docs-linkcheck]
+[testenv: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