[PATCH 2/2] docs: Add info on contributing docs
stephen at that.guru
Sat Sep 10 00:29:43 AEST 2022
Noticed while whipping up a patch to document the new VSCode extension.
Signed-off-by: Stephen Finucane <stephen at that.guru>
docs/development/contributing.rst | 40 +++++++++++++++++++++++++++++++
1 file changed, 40 insertions(+)
diff --git docs/development/contributing.rst docs/development/contributing.rst
index 16b3740d..7bf5e1ca 100644
@@ -141,6 +141,43 @@ for more information.
<release-notes>` using the ``api`` section.
+All documentation files including release notes are authored in
+`reStructuredText`_ (rST). This is similar Markdown but significantly more
+powerful and with a slightly trickier syntax. `Sphinx`_ is used for building
+the documentation tree and the built documentation is published on `Read the
+The documentation tree is broadly broken down into five categories:
+ Documentation for the APIs.
+ Documentation for people that wish to deploy or maintain a Patchwork
+ Documentation for people that wish to contribute to Patchwork itself.
+ Release notes.
+ Documentation for people that wish to use and interact with an existing
+ Patchwork instance.
+When contributing documentation, consider where your new documents should live.
+You should also ensure the documentation builds after your modifications. This
+can be done using the ``docs`` *tox* target.
+.. code-block:: shell
+ $ tox -e docs
@@ -186,5 +223,8 @@ Further information about the Patchwork mailing list is available can be found o
.. _reno: https://docs.openstack.org/developer/reno/
.. _QEMU guidelines: http://wiki.qemu.org/Contribute/SubmitAPatch
.. _Django REST Framework documentation: http://www.django-rest-framework.org/api-guide/versioning/
+.. _reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
+.. _Sphinx: https://www.sphinx-doc.org/en/master/
+.. _Read the Docs: https://readthedocs.org
.. _GitHub issue tracker: https://github.com/getpatchwork/patchwork
.. _lists.ozlabs.org: https://lists.ozlabs.org/listinfo/patchwork
More information about the Patchwork