Published at http://docs.osism.de.
-
On Ubuntu or Debian:
# apt-get install python-pip # pip install tox
-
On RHEL or CentOS (replace yum with dnf on Fedora):
# yum install python-pip # pip install tox
-
On openSUSE or SUSE Linux Enterprise:
# zypper in python-pip # pip install tox
-
On MacOS:
$ brew install python $ pip install tox
-
On Windows:
$ pip install tox
All guides are in the RST format. You can use tox to prepare virtual environment and build all guides (HTML only):
$ tox -e build
You can find the root of the generated HTML documentation at build/html
.
$ export FTP_USERNAME=username
$ export FTP_PASSWORD=password
$ tox -e push
Some documentation files are generated using tools. These files include a do not edit
header
and should not be modified by hand.
This documentation was created by Betacloud Solutions GmbH and is licensed under a Creative Commons Attribution 4.0 International Licence (CC BY-SA 4.0).