21. Ansible Training

The purpose of this repository is the documentation of the Ansible Training of confirm IT solutions. We’re building the docs based on Sphinx Doc, the Python documentation tool.

21.1. Requirements

Before you can work with the docs you’ve to make sure you’ve installed all required Python packages / libraries. To install all dependencies you can use the requirements file.

It’s recommended to use a Python virtualenv and place it in .venv or symlink it to .venv:

# Install virtualenv.
pip install virtualenv virtualenvwrapper

# Create new virtualenv and activate it.
virtualenv .venv
source .venv/bin/activate

# Install Python dependencies.
pip install -r requirements.txt

If you don’t want to use a virtualenv you can simply run the following command to install the dependencies in your system site-packages:

pip install -r requirements.txt

21.2. Build

The built documentation are not included in the git repository However, you can easily build the documentation by running the following command:

cd docs
make html

In case you get an error that the sphinx-build command was not found, you’ve to make sure you’ve installed the requirements and loaded the virtualenv:

.venv/bin/activate

21.3. Auto-Build

cd docs
sphinx-autobuild -H 0.0.0.0 -p 8000 . _build/html