4caa45d00f
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems * Adds version to PDF files Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Add Pygments to fix pep8 failure. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I964ac70a4ab0b1ff92876e85e3bca21e089480b3
53 lines
1.4 KiB
ReStructuredText
53 lines
1.4 KiB
ReStructuredText
Team and repository tags
|
|
========================
|
|
|
|
.. image:: https://governance.openstack.org/tc/badges/python-octaviaclient.svg
|
|
:target: https://governance.openstack.org/tc/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
python-octaviaclient
|
|
====================
|
|
|
|
Octavia client for OpenStack Load Balancing
|
|
|
|
This is an OpenStack Client (OSC) plugin for Octavia, an OpenStack
|
|
Load Balancing project.
|
|
|
|
For more information about Octavia see:
|
|
https://docs.openstack.org/octavia/latest/
|
|
|
|
For more information about the OpenStack Client see:
|
|
https://docs.openstack.org/python-openstackclient/latest/
|
|
|
|
* Free software: Apache license
|
|
* Documentation: https://docs.openstack.org/octavia/latest/
|
|
* Source: https://opendev.org/openstack/python-octaviaclient
|
|
* Release notes: https://docs.openstack.org/releasenotes/python-octaviaclient/
|
|
* Bugs: https://storyboard.openstack.org/#!/project/911
|
|
|
|
Getting Started
|
|
===============
|
|
|
|
.. note:: This is an OpenStack Client plugin. The ``python-openstackclient``
|
|
project should be installed to use this plugin.
|
|
|
|
Octavia client can be installed from PyPI using pip
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install python-octaviaclient
|
|
|
|
If you want to make changes to the Octavia client for testing and contribution,
|
|
make any changes and then run
|
|
|
|
.. code-block:: bash
|
|
|
|
python setup.py develop
|
|
|
|
or
|
|
|
|
.. code-block:: bash
|
|
|
|
pip install -e .
|