diff --git a/doc/source/conf.py b/doc/source/conf.py index 56f24962bf79c9b8d57aff11796dd884022634e8..828b915f2793ec80a3fbbc00ff27672c81f7efef 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -21,7 +21,8 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'openstackdocstheme', - 'sphinxcontrib.apidoc' + 'sphinxcontrib.apidoc', + 'oslo_config.sphinxext', ] apidoc_module_dir = '../../oslo_limit' diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index e1b1cc94d55aacd8e9d44c4576e1742570688411..2ed6fba323efe5861633ed925c106eaaf25f5030 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -1,7 +1,16 @@ -======================== -oslo.limit API Reference -======================== +========= +Reference +========= .. toctree:: + :maxdepth: 2 + + opts + +API +=== + +.. toctree:: + :maxdepth: 1 api/modules diff --git a/doc/source/reference/opts.rst b/doc/source/reference/opts.rst new file mode 100644 index 0000000000000000000000000000000000000000..80509b84fb9026b4c158f16ee5cd628bbb019cf7 --- /dev/null +++ b/doc/source/reference/opts.rst @@ -0,0 +1,9 @@ +===================== +Configuration Options +===================== + +oslo.limit uses oslo.config to define and manage configuration +options to allow the deployer to control how an application uses the +underlying quota limits and enforcement. + +.. show-options:: oslo.limit