diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst index bc3f2157..ca44919d 100644 --- a/RELEASE_NOTES.rst +++ b/RELEASE_NOTES.rst @@ -19,7 +19,7 @@ Release notes 0.17 ---- -* Added support for *-manage CLI doc generation. +* Added support for ``*-manage`` CLI doc generation. * ``openstack-dn2osdbk``: Converts Docutils Native XML to docbook. * ``openstack-doc-test``: Handle the upcoming HOT guide. * ``autohelp.py``: Provide our own sanitizer. @@ -99,7 +99,7 @@ Release notes ---- * Fix ``openstack-doc-test`` to handle changes in ``api-site`` repository: - Do not publish wadls directory, *.fo files and add api-ref-guides + Do not publish wadls directory, ``*.fo`` files and add api-ref-guides PDF files to index file for docs-draft. * Many improvements for generation of option tables. * Improvements for ``openstack-auto-commands``: handle ironic, sahara; @@ -110,7 +110,8 @@ Release notes Fixes for openstack-doc-test: -* openstack-doc-test now validates JSON files for well-formed-ness and whitespace. +* openstack-doc-test now validates JSON files for well-formed-ness and + whitespace. * Create proper chapter title for markdown files. * Ignore publish-docs directory completely. * Do not check for xml:ids in wadl resource. diff --git a/doc/source/man/openstack-doc-test.rst b/doc/source/man/openstack-doc-test.rst index f8590030..11982a49 100644 --- a/doc/source/man/openstack-doc-test.rst +++ b/doc/source/man/openstack-doc-test.rst @@ -14,7 +14,8 @@ openstack-doc-test [options] DESCRIPTION =========== -openstack-doc-test allows to test the validity of the OpenStack documentation content. +openstack-doc-test allows to test the validity of the OpenStack +documentation content. OPTIONS ======= diff --git a/doc/source/release_notes.rst b/doc/source/release_notes.rst index 764448b9..b3ee6814 100644 --- a/doc/source/release_notes.rst +++ b/doc/source/release_notes.rst @@ -1 +1,2 @@ + .. include:: ../../RELEASE_NOTES.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 1c3a07ae..c1779bd1 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -4,4 +4,4 @@ Usage To use openstack-doc-tools in a project:: - import os_doc_tools + import os_doc_tools diff --git a/test-requirements.txt b/test-requirements.txt index dc6cef89..6c1ff0c8 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,3 +1,4 @@ +doc8 # Hacking already pins down pep8, pyflakes and flake8 hacking>=0.9.2,<0.10 pylint==0.25.2 diff --git a/tox.ini b/tox.ini index eab1591a..816966e3 100644 --- a/tox.ini +++ b/tox.ini @@ -12,7 +12,12 @@ deps = -r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt [testenv:pep8] -commands = flake8 +commands = + flake8 + # Run doc8 to check .rst and .txt files. + # HACKING.rst is the only file that is not referenced from + # doc/source, so add it explicitely. + doc8 -e txt -e rst doc/source/ HACKING.rst [testenv:pylint] commands = pylint os_doc_tools cleanup