diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 74b8cd8..7dc5710 100644 --- a/doc/source/admin/index.rst +++ b/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 `_. diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index c73bdfd..4905d5a 100644 --- a/doc/source/cli/index.rst +++ b/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: diff --git a/doc/source/conf.py b/doc/source/conf.py index a1aad38..49886c6 100755 --- a/doc/source/conf.py +++ b/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. diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index 5861c19..fb3f804 100644 --- a/doc/source/configuration/index.rst +++ b/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 `_ settings. diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst deleted file mode 100644 index 2aa0707..0000000 --- a/doc/source/contributor/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 38cef81..c77027c 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -2,8 +2,13 @@ Contributor Documentation ========================= +Contributor Guidelines +---------------------- .. toctree:: - :maxdepth: 2 + :glob: + :maxdepth: 1 - contributing + Octavia Constitution + Octavia Style Commandments +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 5405475..14a25e0 100644 --- a/doc/source/index.rst +++ b/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 diff --git a/doc/source/library/index.rst b/doc/source/library/index.rst index a4bd318..c973734 100644 --- a/doc/source/library/index.rst +++ b/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 `_. - import octavia_lib +Indices and Search +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 07a2451..06489ef 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -2,7 +2,21 @@ References ========== -References of octavia-lib. +.. toctree:: + :glob: + :maxdepth: 1 + + Octavia Introduction + Octavia Glossary + Octavia Project Documentation + Octavia API Reference + +Indices and Search +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` .. toctree:: :hidden: diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 52cf92a..2e157f7 100644 --- a/doc/source/user/index.rst +++ b/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 `_. diff --git a/lower-constraints.txt b/lower-constraints.txt index 8dec028..56145d1 100644 --- a/lower-constraints.txt +++ b/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 diff --git a/octavia_lib/api/drivers/data_models.py b/octavia_lib/api/drivers/data_models.py index a4b764b..d34f294 100644 --- a/octavia_lib/api/drivers/data_models.py +++ b/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, diff --git a/requirements.txt b/requirements.txt index 0a6f803..74375a9 100644 --- a/requirements.txt +++ b/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 diff --git a/tox.ini b/tox.ini index 5fb3ee9..4bf32e2 100644 --- a/tox.ini +++ b/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