To conform to documentation best practices add a
spellchecker. A Sphinx extension is used.
Correct any current spelling mistakes across the
doc set.
Add a seeding file that extends the system dictionary.
Going forward, the 'spelling_words.txt' file will
be used to extend the dictionary.
Do not enforce spelling during a normal doc build; add
a new tox target.
Add a non-voting Zuul job that consumes the new tox
target.
The doc-contrib documentation will include information
on the spellchecker in a subsequent PR.
Future work is necessary in terms of making checking more
intelligent. As such, file 'dubious_words.txt' has been
added to temporarily store those words that should be
filtered. For instance, the word 'tis' is in this file
because it is part of proper noun 'tpm-tis'. Hyphenated
words (or words in single quotes) could be exempt from
the check.
Change-Id: I70a1d5208b97923c081b359af3208f4de65eb6ca
publish-openstack-sphinx-docs jobs are obsolete since some time,
use the newer publish-openstack-docs-pti jobs instead.
Update tox.ini to use the PTI way of building docs.
Fix all RST errors found so that this builds cleanly now.
Change-Id: I61dd9c0a2caa1b2e0c5e71c609091b7bb356520a
This is a mechanically generated patch to complete step 1 of moving
the zuul job settings out of project-config and into each project
repository.
Because there will be a separate patch on each branch, the branch
specifiers for branch-specific jobs have been removed.
Because this patch is generated by a script, there may be some
cosmetic changes to the layout of the YAML file(s) as the contents are
normalized.
See the python3-first goal document for details:
https://governance.openstack.org/tc/goals/stein/python3-first.html
Change-Id: Iadf4f1764ffe7059be8460b0c17acd1febd5d989
Story: #2002586
Task: #24317
Peter Matulis