diff --git a/README.rst b/README.rst index adad8cb..1229c91 100644 --- a/README.rst +++ b/README.rst @@ -21,7 +21,7 @@ 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/ +* Documentation: https://docs.openstack.org/python-octaviaclient/latest/ * Source: https://opendev.org/openstack/python-octaviaclient * Release notes: https://docs.openstack.org/releasenotes/python-octaviaclient/ * Bugs: https://storyboard.openstack.org/#!/project/911 @@ -32,6 +32,10 @@ Getting Started .. note:: This is an OpenStack Client plugin. The ``python-openstackclient`` project should be installed to use this plugin. +.. note:: This project is only intended to be used for the OpenStack Client + CLI. The `openstacksdk `_ + should be used for python bindings. + Octavia client can be installed from PyPI using pip .. code-block:: bash diff --git a/doc/source/index.rst b/doc/source/index.rst index c4caea7..56943f3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,6 +11,10 @@ Python Octavia Client The Python Octavia Client (python-octaviaclient) is a command-line client for the OpenStack Load Balancing service. +.. note:: This project is only intended to be used for the OpenStack Client + CLI. The `openstacksdk `_ + should be used for python bindings. + Getting Started ---------------