Clean up octavia-lib docs and remove oslo.log

This patch cleans up the octavia-lib documentation and removes an
unused requirement for oslo.log.

Change-Id: I4ddcb51fcfb976e825cd204d5f4f561d60ee0455

doc/source/admin/index.rst

@@ -2,4 +2,9 @@
 Administrators guide
 ====================
 
-Administrators guide of octavia-lib.
+The octavia-lib is a library supporting Octavia provider drivers.
+
+There are no administrator tasks or settings for octavia-lib.
+
+Information on administrating Octavia deployments is available in the
+`Octavia Administration Guide <https://docs.openstack.org/octavia/latest/admin/index.html>`_.

doc/source/cli/index.rst

@@ -2,7 +2,7 @@
 Command line interface reference
 ================================
 
-Octavia-lib does not provide a CLI.
+The octavia-lib library does not provide a CLI.
 
 See the python-octaviaclient for the Octavia CLI:
 

doc/source/conf.py

@@ -47,7 +47,9 @@ apidoc_output_dir = 'reference/modules'
 apidoc_module_dir = '../../octavia_lib'
 apidoc_excluded_paths = [
   'tests',
-  'db/migration'
+  'db/migration',
+  'hacking',
+  'i18n.py'
 ]
 
 # If true, '()' will be appended to :func: etc. cross-reference text.

doc/source/configuration/index.rst

@@ -2,4 +2,4 @@
 Configuration
 =============
 
-Configuration of octavia-lib.
+The octavia-lib library does not currently use any `oslo configuration <https://docs.openstack.org/oslo.config/latest/>`_ settings.

doc/source/contributor/contributing.rst

@@ -1,4 +0,0 @@
-============
-Contributing
-============
-.. include:: ../../../CONTRIBUTING.rst

doc/source/contributor/index.rst

@@ -2,8 +2,13 @@
 Contributor Documentation
 =========================
 
+Contributor Guidelines
+----------------------
 .. toctree::
-   :maxdepth: 2
+   :glob:
+   :maxdepth: 1
 
-   contributing
+   Octavia Constitution <https://docs.openstack.org/octavia/latest/contributor/CONSTITUTION.html>
+   Octavia Style Commandments <https://docs.openstack.org/octavia/latest/contributor/HACKING.html>
 
+.. include:: ../../../CONTRIBUTING.rst

doc/source/index.rst

@@ -4,15 +4,17 @@
    contain the root `toctree` directive.
 
 ===========================================
-Welcome to the documentation of octavia_lib
+Welcome to the documentation of Octavia lib
 ===========================================
 
-Contents:
+.. include:: ../../README.rst
+
+octavia-lib Documentation:
+--------------------------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   readme
    install/index
    library/index
    contributor/index

doc/source/library/index.rst

@@ -2,6 +2,11 @@
 Usage
 =====
 
-To use octavia-lib in a project::
+Instructions for using the library are provided in the `Provider Driver Development Guide <https://docs.openstack.org/octavia/latest/contributor/guides/providers.html>`_.
 
-    import octavia_lib
+Indices and Search
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/source/readme.rst

@@ -1 +0,0 @@
-.. include:: ../../README.rst

doc/source/reference/index.rst

@@ -2,7 +2,21 @@
 References
 ==========
 
-References of octavia-lib.
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   Octavia Introduction <https://docs.openstack.org/octavia/latest/reference/introduction.html>
+   Octavia Glossary <https://docs.openstack.org/octavia/latest/reference/glossary.html>
+   Octavia Project Documentation <https://docs.openstack.org/octavia/latest/>
+   Octavia API Reference <https://docs.openstack.org/api-ref/load-balancer/>
+
+Indices and Search
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
 
 .. toctree::
    :hidden:

doc/source/user/index.rst

@@ -2,4 +2,6 @@
 Users guide
 ===========
 
-Users guide of octavia-lib.
+The octavia-lib is a library supporting Octavia provider drivers.
+
+Instructions for using the library are provided in the `Provider Driver Development Guide <https://docs.openstack.org/octavia/latest/contributor/guides/providers.html>`_.

lower-constraints.txt

@@ -4,7 +4,6 @@ doc8==0.6.0
 hacking==0.12.0
 mock==2.0.0
 oslo.i18n==3.15.3
-oslo.log==3.36.0
 oslo.serialization==2.28.1
 oslo.utils==3.33.0
 oslotest==3.2.0

octavia_lib/api/drivers/data_models.py

@@ -17,10 +17,6 @@
 
 import six
 
-from oslo_log import log as logging
-
-LOG = logging.getLogger(__name__)
-
 
 class BaseDataModel(object):
     def to_dict(self, calling_classes=None, recurse=False,

requirements.txt

@@ -3,7 +3,6 @@
 # process, which may cause wedges in the gate later.
 
 oslo.i18n>=3.15.3 # Apache-2.0
-oslo.log>=3.36.0 # Apache-2.0
 oslo.serialization>=2.28.1 # Apache-2.0
 pbr!=2.1.0,>=2.0.0 # Apache-2.0
 six>=1.10.0 # MIT

tox.ini

@@ -47,7 +47,10 @@ commands =
 [testenv:docs]
 basepython = python3
 deps = -r{toxinidir}/doc/requirements.txt
-commands = sphinx-build -W -b html doc/source doc/build/html
+whitelist_externals = rm
+commands =
+  rm -rf doc/build doc/source/reference/modules
+  sphinx-build -W -b html doc/source doc/build/html
 
 [testenv:releasenotes]
 basepython = python3