From 4f44b97017e7f2b5920065f63df9ebe50027f4fb Mon Sep 17 00:00:00 2001 From: Mark McLoughlin Date: Wed, 10 Jul 2013 08:22:13 +0100 Subject: [PATCH] Hook docstrings into the published docs Fixes bug #1182842 We've always had pretty decent documentation coverage in the docstrings but have never taken the time to hook them into the published docs. This is a first-cut at doing that. There's plenty of rough edges, but it's a good start. Change-Id: I62a509e7d6e156e9b67e75bef9da68fbfc4601ac --- doc/source/cfg.rst | 5 +++++ doc/source/configopts.rst | 8 ++++++++ doc/source/exceptions.rst | 16 ++++++++++++++++ doc/source/helpers.rst | 8 ++++++++ doc/source/index.rst | 11 ++++++++--- doc/source/opts.rst | 17 +++++++++++++++++ doc/source/parser.rst | 11 +++++++++++ 7 files changed, 73 insertions(+), 3 deletions(-) create mode 100644 doc/source/cfg.rst create mode 100644 doc/source/configopts.rst create mode 100644 doc/source/exceptions.rst create mode 100644 doc/source/helpers.rst create mode 100644 doc/source/opts.rst create mode 100644 doc/source/parser.rst diff --git a/doc/source/cfg.rst b/doc/source/cfg.rst new file mode 100644 index 0000000..c444bcb --- /dev/null +++ b/doc/source/cfg.rst @@ -0,0 +1,5 @@ +-------------- +The cfg Module +-------------- + +.. automodule:: oslo.config.cfg diff --git a/doc/source/configopts.rst b/doc/source/configopts.rst new file mode 100644 index 0000000..5ee090d --- /dev/null +++ b/doc/source/configopts.rst @@ -0,0 +1,8 @@ +-------------------- +The ConfigOpts Class +-------------------- + +.. currentmodule:: oslo.config.cfg + +.. autoclass:: ConfigOpts + :members: diff --git a/doc/source/exceptions.rst b/doc/source/exceptions.rst new file mode 100644 index 0000000..5d09066 --- /dev/null +++ b/doc/source/exceptions.rst @@ -0,0 +1,16 @@ +---------- +Exceptions +---------- + +.. currentmodule:: oslo.config.cfg + +.. autoexception:: Error +.. autoexception:: ArgsAlreadyParsedError +.. autoexception:: NoSuchOptError +.. autoexception:: NoSuchGroupError +.. autoexception:: DuplicateOptError +.. autoexception:: RequiredOptError +.. autoexception:: TemplateSubstitutionError +.. autoexception:: ConfigFilesNotFoundError +.. autoexception:: ConfigFileParseError +.. autoexception:: ConfigFileValueError diff --git a/doc/source/helpers.rst b/doc/source/helpers.rst new file mode 100644 index 0000000..66fbba4 --- /dev/null +++ b/doc/source/helpers.rst @@ -0,0 +1,8 @@ +---------------- +Helper Functions +---------------- + +.. currentmodule:: oslo.config.cfg + +.. autofunction:: find_config_files +.. autofunction:: set_defaults diff --git a/doc/source/index.rst b/doc/source/index.rst index a720e67..fc5e77e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,12 +5,17 @@ An OpenStack library for parsing configuration options from the command line and configuration files. Contents --------- +======== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - api/autoindex + cfg + opts + configopts + helpers + parser + exceptions Release Notes ============= diff --git a/doc/source/opts.rst b/doc/source/opts.rst new file mode 100644 index 0000000..6bbb2cf --- /dev/null +++ b/doc/source/opts.rst @@ -0,0 +1,17 @@ +------------------ +Option Definitions +------------------ + +.. currentmodule:: oslo.config.cfg + +.. autoclass:: Opt +.. autoclass:: StrOpt +.. autoclass:: BoolOpt +.. autoclass:: IntOpt +.. autoclass:: FloatOpt +.. autoclass:: ListOpt +.. autoclass:: DictOpt +.. autoclass:: MultiStrOpt +.. autoclass:: DeprecatedOpt +.. autoclass:: SubCommandOpt +.. autoclass:: OptGroup diff --git a/doc/source/parser.rst b/doc/source/parser.rst new file mode 100644 index 0000000..6cc0cd5 --- /dev/null +++ b/doc/source/parser.rst @@ -0,0 +1,11 @@ +------------ +File Parsing +------------ + +.. autoclass:: oslo.config.iniparser.BaseParser + +.. autoclass:: oslo.config.cfg.ConfigParser + :members: parse + +.. autoclass:: oslo.config.cfg.MultiConfigParser + :members: read, get