diff options
| author |   Rich Bennett <rb2745@att.com> | 2018-04-26 09:30:57 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2018-04-26 09:42:54 -0400 |
| commit | 9c3af50160a00efae37e8a397a046d1c786596f8 (patch) | |
| tree | fab437abeee7d92988c93230568e7070f61b0ad7 /docs/guides/onap-developer/how-to-use-docs/include-documentation.rst | |
| parent | 5079b4dc3225ccc14b677e5e2b5ab10538eec6f2 (diff) | |
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
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/include-documentation.rst')
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/include-documentation.rst | 18 |
1 files changed, 16 insertions, 2 deletions
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 fb32a3e36..28c7aeb99 100644 --- 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 + |