mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Document the tests that are currently run on documentation pull requests. (#48436)
This commit is contained in:
parent
27827ce728
commit
806442b3ec
1 changed files with 13 additions and 0 deletions
|
@ -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
|
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
|
Joining the documentation working group
|
||||||
=======================================
|
=======================================
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue