e8fac460b8
This patch enables building .pdf documentation using new 'pdf-docs' tox environment. The newly created tox environment creates latex source codes using sphinx-build and then builds the pdf documentation using make. The patch also fixes documentation to reflect change from openstack to osf organization fixes copy-paste mistakes in the doc configs. Change-Id: I15a03442c2a2c355c8e7f1658c1b2329eb38c7df
48 lines
1.1 KiB
ReStructuredText
48 lines
1.1 KiB
ReStructuredText
============
|
|
Installation
|
|
============
|
|
|
|
Git
|
|
---
|
|
|
|
1. Clone and change to the directory::
|
|
|
|
$ git clone https://opendev.org/osf/python-tempestconf
|
|
$ cd python-tempestconf
|
|
|
|
2. Create a virtual environment using :command:`virtualenv`::
|
|
|
|
$ virtualenv .venv
|
|
$ source .venv/bin/activate
|
|
|
|
3. Install requirements in the newly created virtual environment::
|
|
|
|
(.venv) $ pip install .
|
|
|
|
4. *(optional)* Instead of manual installation described in steps 2 and 3
|
|
above, tox can be used for installing the requirements as well.
|
|
To create python 3.6 environment run following::
|
|
|
|
$ tox -epy36
|
|
$ source .tox/py36/bin/activate
|
|
|
|
RPM Installation (RDO)
|
|
----------------------
|
|
|
|
* ``python-tempestconf`` package can be installed as follows::
|
|
|
|
$ sudo yum install python-tempestconf
|
|
|
|
* ``python-tempestconf`` is installed together with ``openstack-tempest``, as
|
|
a new dependency (starting **from** the **Ocata** release)::
|
|
|
|
$ sudo yum install openstack-tempest
|
|
|
|
|
|
Pip installation
|
|
----------------
|
|
|
|
Install ``python-tempestconf`` via pip as follows::
|
|
|
|
$ pip install python-tempestconf
|