Update python-octaviaclient docs for migration
This patch updates the python-octaviaclient project for the OpenStack documentation migration [1]. [1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Change-Id: Id873ab00fcc80507d841bcfade47fa2308100099
This commit is contained in:
parent
ea479e2de2
commit
b1afaa3b54
|
@ -17,19 +17,22 @@ This is an OpenStack Client (OSC) plugin for Octavia, an OpenStack
|
|||
Load Balancing project.
|
||||
|
||||
For more information about Octavia see:
|
||||
http://docs.openstack.org/developer/octavia
|
||||
https://docs.openstack.org/octavia/latest/
|
||||
|
||||
For more information about the OpenStack Client see:
|
||||
https://docs.openstack.org/developer/python-openstackclient
|
||||
https://docs.openstack.org/python-openstackclient/latest/
|
||||
|
||||
* Free software: Apache license
|
||||
* Documentation: http://docs.openstack.org/developer/python-octaviaclient
|
||||
* Documentation: https://docs.openstack.org/octavia/latest/
|
||||
* Source: http://git.openstack.org/cgit/openstack/python-octaviaclient
|
||||
* Bugs: http://bugs.launchpad.net/octavia
|
||||
|
||||
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::
|
||||
|
||||
pip install python-octaviaclient
|
||||
|
|
|
@ -22,8 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
#'sphinx.ext.intersphinx',
|
||||
'oslosphinx'
|
||||
'openstackdocstheme'
|
||||
]
|
||||
|
||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||
|
@ -58,6 +57,8 @@ pygments_style = 'sphinx'
|
|||
# html_theme = '_theme'
|
||||
# html_static_path = ['static']
|
||||
|
||||
html_theme = 'openstackdocs'
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = '%sdoc' % project
|
||||
|
||||
|
@ -73,3 +74,10 @@ latex_documents = [
|
|||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
#intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/python-octaviaclient'
|
||||
bug_project = 'octavia'
|
||||
bug_tag = 'doc'
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
============
|
||||
Contributing
|
||||
============
|
||||
.. include:: ../../CONTRIBUTING.rst
|
||||
.. include:: ../../../CONTRIBUTING.rst
|
|
@ -15,9 +15,9 @@ Getting Started
|
|||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
installation
|
||||
contributing
|
||||
Project Overview <readme>
|
||||
install/index
|
||||
contributor/index
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
@ -25,12 +25,11 @@ Usage
|
|||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
usage/osc_cli_plugins
|
||||
decoder
|
||||
cli/index
|
||||
reference/index
|
||||
|
||||
Indices and tables
|
||||
------------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
|
|
@ -0,0 +1,17 @@
|
|||
============
|
||||
Installation
|
||||
============
|
||||
|
||||
This is an OpenStack Client plugin for the load-balancer (Octavia) project.
|
||||
|
||||
Install the load-balancer (Octavia) plugin::
|
||||
|
||||
$ pip install python-octaviaclient
|
||||
|
||||
Or, if you have virtualenvwrapper installed::
|
||||
|
||||
$ mkvirtualenv python-octaviaclient
|
||||
$ pip install python-octaviaclient
|
||||
|
||||
.. note:: If python-openstackclient is not already installed it will be
|
||||
installed as part of the requirements for the Octavia client plugin.
|
|
@ -1,12 +0,0 @@
|
|||
============
|
||||
Installation
|
||||
============
|
||||
|
||||
At the command line::
|
||||
|
||||
$ pip install python-octaviaclient
|
||||
|
||||
Or, if you have virtualenvwrapper installed::
|
||||
|
||||
$ mkvirtualenv python-octaviaclient
|
||||
$ pip install python-octaviaclient
|
|
@ -6,8 +6,8 @@ the Octavia plugin into OSC. Think of it as a magic decoder ring if you were
|
|||
using the legacy CLIs and want to transition to OpenStack CLI.
|
||||
Command options are only shown when necessary.
|
||||
|
||||
``LBaaS v2 CLI``
|
||||
----------------
|
||||
LBaaS v2 CLI
|
||||
------------
|
||||
|
||||
.. csv-table::
|
||||
:header: "Neutron CLI", "OSC Equivalent", "Description"
|
|
@ -0,0 +1,7 @@
|
|||
Python Octavia Client Reference
|
||||
===============================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
decoder
|
|
@ -5,7 +5,7 @@ description-file =
|
|||
README.rst
|
||||
author = OpenStack
|
||||
author-email = openstack-dev@lists.openstack.org
|
||||
home-page = http://docs.openstack.org/developer/python-octaviaclient
|
||||
home-page = https://docs.openstack.org/python-octaviaclient/latest/
|
||||
classifier =
|
||||
Environment :: OpenStack
|
||||
Intended Audience :: Information Technology
|
||||
|
@ -67,6 +67,7 @@ openstack.load_balancer.v2 =
|
|||
source-dir = doc/source
|
||||
build-dir = doc/build
|
||||
all_files = 1
|
||||
warning-is-error = 1
|
||||
|
||||
[upload_sphinx]
|
||||
upload-dir = doc/build/html
|
||||
|
|
|
@ -11,7 +11,7 @@ keystoneauth1>=2.21.0 # Apache-2.0
|
|||
python-subunit>=0.0.18 # Apache-2.0/BSD
|
||||
python-openstackclient!=3.10.0,>=3.3.0 # Apache-2.0
|
||||
sphinx>=1.6.2 # BSD
|
||||
oslosphinx>=4.7.0 # Apache-2.0
|
||||
openstackdocstheme>=1.16.0 # Apache-2.0
|
||||
oslotest>=1.10.0 # Apache-2.0
|
||||
testrepository>=0.0.18 # Apache-2.0/BSD
|
||||
testscenarios>=0.4 # Apache-2.0/BSD
|
||||
|
|
Loading…
Reference in New Issue