This repository documents standard operating procedures for applications Fedora Infrastructure deploys and covers application development best practices for those applications we maintain ourselves.
This is designed to be consumed as a Sphinx documentation project. Documentation is available online on pagure and on Read the Docs.
To build the documentation locally, create a virtualenv and install the requirements:
$ sudo dnf install python-virtualenvwrapper $ mkvirtualenv -a $(pwd) infra-docs $ pip install -r requirements.txt
then build the documentation and open it in a browser of your choice:
$ cd docs $ make html $ firefox _build/html/index.html
To leave the virtual environment:
$ deactivate
Finally, when you want to work on the documentation, you can re-enter the virtual environment with:
$ workon infra-docs
It will automatically change the current working directory to the repository root.