diff options
| author | Jan Safranek <jsafrane@redhat.com> | 2013-10-02 10:42:35 +0200 |
|---|---|---|
| committer | Jan Safranek <jsafrane@redhat.com> | 2013-10-02 10:42:35 +0200 |
| commit | a37dff6a40bff57df67d084e8b7bcce0ede78242 (patch) | |
| tree | 78bf360b7da9d65ee63eb8bfdfb1d14a79d86d14 | |
| parent | 3a075862fdf96b05c00165fa3796d82f634c80be (diff) | |
| download | openlmi-providers-a37dff6a40bff57df67d084e8b7bcce0ede78242.tar.gz openlmi-providers-a37dff6a40bff57df67d084e8b7bcce0ede78242.tar.xz openlmi-providers-a37dff6a40bff57df67d084e8b7bcce0ede78242.zip | |
Remove 'OpenLMI LogicalFile CIM classes' from overall documentation.
| -rw-r--r-- | src/logicalfile/doc/source/conf.py | 7 | ||||
| -rw-r--r-- | src/logicalfile/doc/source/index.rst | 12 |
2 files changed, 13 insertions, 6 deletions
diff --git a/src/logicalfile/doc/source/conf.py b/src/logicalfile/doc/source/conf.py index 973efbb..29001e1 100644 --- a/src/logicalfile/doc/source/conf.py +++ b/src/logicalfile/doc/source/conf.py @@ -12,6 +12,11 @@ import sys, os +def setup(app): + # Register new option to include class list and class tree in index.rst + app.add_config_value('includeClasses', 'True', True) +includeClasses = True + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -24,7 +29,7 @@ import sys, os # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] +extensions = ['sphinx.ext.ifconfig', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/src/logicalfile/doc/source/index.rst b/src/logicalfile/doc/source/index.rst index c2fd199..5ee12ca 100644 --- a/src/logicalfile/doc/source/index.rst +++ b/src/logicalfile/doc/source/index.rst @@ -16,10 +16,12 @@ Contents: usage -OpenLMI LogicalFile CIM Classes: +.. ifconfig:: includeClasses -.. toctree:: - :maxdepth: 1 + OpenLMI LogicalFile CIM Classes: + + .. toctree:: + :maxdepth: 1 - mof/tree - mof/index + mof/tree + mof/index |