Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Working in the root of the repository, issue the following command to generate documentation. This assumes you have Python and Tox installed on the machine where you are working.

...

No Format
tox -e docs,docs-linkcheck

...

Step 4: Add a link to your-repo documentation

...

No Format
* :doc:`Your Project <your-repo:index>

Step 4: Test publication

Edit a file in your docs/ area, commit the file to git and push your commit to Gerrit for review.  You should see a documentation build job start.