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. Management of the virtual environment can be done with pipenv as described below.
Python 3 installation instructions can be found on the Python website.
Building the documentation on a Debian system
The following example shows how to build the documentation on a Debian system:
# Install required operating system packages sudo apt-get install python3 python3-pip make # install pipenv python3 -m pip install -U pip pipenv # use pipenv to install require dependencies into a virtual environment cd docs pipenv install # Build the documentation in the docs subdirectory pipenv run make html
The above commands should be run from the root directory of a git clone
of the cacert-infradocs git repository. The result of the make
exection will be available in the
Getting the documentation source¶
The documentation is available from the git repository cacert-infradocs on git.cacert.org. You can browse the repository via gitweb.
You can clone the repository anonymously by executing:
git clone git://git.cacert.org/cacert-infradocs.git
If you want to contribute to the documentation please ask firstname.lastname@example.org to setup a user in the group git-infra on git.cacert.org 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 executing:
git clone ssh://<username>@git.cacert.org/var/cache/git/cacert-infradocs.git
<username> with your actual username