path: root/docs
diff options
Diffstat (limited to 'docs')
2 files changed, 79 insertions, 0 deletions
diff --git a/docs/building.rst b/docs/building.rst
new file mode 100644
index 0000000..be32e64
--- /dev/null
+++ b/docs/building.rst
@@ -0,0 +1,78 @@
+Building the documentation
+This documentation is maintained as a set of ReStructuredText documents and
+uses `Sphinx <>`_ to build HTML formatted
+representations of the documents.
+To build this documentation you need a Python 3 installation. To isolate the
+documentation build from your system Python 3 packages using a virtual
+environment is recommended.
+Python 3 installation instructions can be found on the `Python website`_.
+.. _Python website:
+.. topic:: Building the documentation on a Debian system
+ The following example shows how to build the documentation on a Debian system:
+ .. code-block:: bash
+ # Install required operating system packages
+ sudo apt-get install python3 python3-venv make
+ # Setup a fresh virtual Python environment in the venv subdirectory
+ pyvenv venv
+ # Activate the virtual environment
+ . venv/bin/activate
+ # Install the documentation build dependencies (Sphinx, extensions and
+ # their dependencies)
+ pip install -r doc-requirements.txt
+ # Build the documentation in the docs subdirectory
+ cd docs
+ make html
+ .. note::
+ The above commands should be run from the root directory of a git clone
+ of the cacert-infradocs git repository. The result of the :program:`make`
+ exection will be available in the :file:`_build/html/` directory inside
+ the :file:`docs/` directory.
+Getting the documentation source
+The documentation is available from the git repository cacert-infradocs on You can browse the `repository
+<;a=summary>`_ via gitweb.
+You can clone the repository anonymously by executing::
+ git clone git://
+If you want to contribute to the documentation please ask
+to setup a user in the group git-infra on for you. You will have
+to provide an SSH public key (either RSA with at least 2048 Bits modulus or an
+ECDSA or ED25519 key with similar strength) with your request.
+If you have a user in the git-infra group you can clone the repository by
+ git clone ssh://<username>
+.. note:: replace ``<username>`` with your actual username
+Continuous integration
+If changes are pushed to the cacert-infradocs git repository on
+a `Jenkins Job <>`_ is
+automatically triggered. If the documentation is built successfully it can be
+viewed in the `docs/_build/html directory of the Job's workspace
+<>`_. You may
+open `index.html
+to browse the documentation.
+.. todo:: publish the generated documentation to some canonical place
diff --git a/docs/index.rst b/docs/index.rst
index 17a4e83..bff2526 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -21,6 +21,7 @@ Contents:
+ building
Indices and tables