- Introduce new tox environments `docs-lint` and `docs-all`
- `docs-lint` will check for dead links and run spellchecking
- `docs-all` will force a rebuild for all documentation
- Update documentation and docstrings to pass linting; this includes
some innocuous code changes for modernization
- Run `tox -e docs-lint` on RTD before the docs are built
* updated Makefile to:
* create a virtualenv for the documentation (``make install``)
* provide a ``make run`` command
* provide a ``make spelling`` command
* added a requirements_docs.txt
* added a spelling_wordlist for special words
* corrected various spelling errors
* updated conf.py to use RTD theme for local building
* restyled documentation home page, added logo
* moved content into tutorial/how-to/reference/background sections as appropriate
* renamed "internals" to "project"
* added internal reference links
* suppressed orphan warning for numerous pages
* updated .gitignore for /docs/env
(cherry picked from commit 96f383f)
Signed-off-by: Jonas Schell <jonasschell@ocupe.org>
* updated Makefile to:
* create a virtualenv for the documentation (``make install``)
* provide a ``make run`` command
* provide a ``make spelling`` command
* added a requirements_docs.txt
* added a spelling_wordlist for special words
* corrected various spelling errors
* updated conf.py to use RTD theme for local building
* restyled documentation home page, added logo
* moved content into tutorial/how-to/reference/background sections as appropriate
* renamed "internals" to "project"
* added internal reference links
* suppressed orphan warning for numerous pages
* updated .gitignore for /docs/env
1. Add links to the classes in the text at the bottom of the second tutorial
2. Update conf.py to use the sphinx-rtd-theme if can be imported so the documentation can built and tested locally.
3. Fix the headers in the Readme to not be beyond the header text.
This patch adds the ability to document the UI toolkit using
base abstract classes, and includes those docs in the reference
doc section.
Signed-off-by: Richard Jones <r1chardj0n3s@gmail.com>
