From 63536c6da62a8365ecc2b13ec40e4f0a92bc49da Mon Sep 17 00:00:00 2001
From: melanie witt <melwittt@gmail.com>
Date: Thu, 3 Mar 2022 00:28:56 +0000
Subject: [PATCH] Add documentation for config options

This adds a doc page for oslo.limit config options by auto-generating
them.

Change-Id: I49070fdbf2172f87bafd4d2bd08af282c9ef29a4
(cherry picked from commit 9f7a66a27317c3e9d67f7c3ecc25f6ef7b592171)
---
 doc/source/conf.py             |  3 ++-
 doc/source/reference/index.rst | 15 ++++++++++++---
 doc/source/reference/opts.rst  |  9 +++++++++
 3 files changed, 23 insertions(+), 4 deletions(-)
 create mode 100644 doc/source/reference/opts.rst

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 56f2496..828b915 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 e1b1cc9..2ed6fba 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 0000000..80509b8
--- /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