diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2015-08-26 17:19:12 +0000 |
|---|---|---|
| committer | Davanum Srinivas <davanum@gmail.com> | 2015-08-27 06:06:44 -0400 |
| commit | ea893e8ba417aeb13455acfda30b8337159b8536 (patch) | |
| tree | eef50b9ca615b8f7e79d0ec40cbe54cacc41b014 /doc/source | |
| parent | 95b735d1f009c7339a664364a553a866f40f1039 (diff) | |
| download | oslo-middleware-ea893e8ba417aeb13455acfda30b8337159b8536.tar.gz | |
Split option discovery function by middleware
Create separate option discovery functions for each piece of middleware,
so an application that only uses one piece can include only those
options in its sample configuration file.
Test the results with some unit tests that simply ensure the functions
do not raise exceptions, and by adding configuration options to the
documentation for the library, using the new integration of oslo.config
with sphinx.
Change-Id: I4c777cd70c063441f430c48ab1f9c9cac2c1fc75
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/api.rst | 13 | ||||
| -rwxr-xr-x | doc/source/conf.py | 5 | ||||
| -rw-r--r-- | doc/source/cors.rst | 5 |
3 files changed, 21 insertions, 2 deletions
diff --git a/doc/source/api.rst b/doc/source/api.rst index 38cd96c..50ad06d 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -4,3 +4,16 @@ .. automodule:: oslo_middleware :members: + +Configuration Options +===================== + +RequestBodySizeLimiter +~~~~~~~~~~~~~~~~~~~~~~ + +.. show-options:: oslo.middleware.sizelimit + +SSLMiddleware +~~~~~~~~~~~~~ + +.. show-options:: oslo.middleware.ssl diff --git a/doc/source/conf.py b/doc/source/conf.py index c5178f1..6265ab6 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,8 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx' + 'oslosphinx', + 'oslo_config.sphinxext', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -72,4 +73,4 @@ latex_documents = [ ] # Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None}
\ No newline at end of file +#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/doc/source/cors.rst b/doc/source/cors.rst index 09f5d77..890f7fd 100644 --- a/doc/source/cors.rst +++ b/doc/source/cors.rst @@ -105,6 +105,11 @@ will add CORS support. To add multiple domains, simply add another filter.:: expose_headers=Content-Type,Cache-Control,Content-Language,Expires,Last-Modified,Pragma,X-Custom-Header +Configuration Options +--------------------- + +.. show-options:: oslo.middleware.cors + Module Documentation -------------------- |