From 806442b3ec1345445fb8babc84f94b939e56db3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Kr=C3=BCger?= Date: Tue, 13 Nov 2018 15:39:00 +0100 Subject: [PATCH] Document the tests that are currently run on documentation pull requests. (#48436) --- .../rst/community/documentation_contributions.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/docsite/rst/community/documentation_contributions.rst b/docs/docsite/rst/community/documentation_contributions.rst index 4ac9417420..8c6eb44522 100644 --- a/docs/docsite/rst/community/documentation_contributions.rst +++ b/docs/docsite/rst/community/documentation_contributions.rst @@ -163,6 +163,19 @@ For example: sphinx-build -b html -c rst/ rst/dev_guide/ _build/html/dev_guide/ rst/dev_guide/developing_modules_documenting.rst +Running the final tests +^^^^^^^^^^^^^^^^^^^^^^^ + +When you submit a documentation pull request, automated tests are run. Those same tests can be run locally. To do so, navigate to the repository's top directory and run: + +.. code-block:: bash + + make clean && + bin/ansible-test sanity --test docs-build && + bin/ansible-test sanity --test rstcheck + +Unfortunately, leftover rST-files from previous document-generating can occasionally confuse these tests. It is therefore safest to run them on a clean copy of the repository, which is the purpose of ``make clean``. If you type these three lines one at a time and manually check the success of each, you do not need the ``&&``. + Joining the documentation working group =======================================