[doc-migration] Adds configuration folder

Change-Id: I5ce1e8acbc1c283535b65675d6805792ea7de8f3
Closes-bug: #1706180
This commit is contained in:
Madhuri Kumari 2017-07-25 12:17:21 +05:30
parent 3a6f56a750
commit d1a41f74f3
4 changed files with 34 additions and 1 deletions

View File

@ -23,13 +23,18 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.graphviz',
'stevedore.sphinxext',
'openstackdocstheme'
'openstackdocstheme',
'oslo_config.sphinxconfiggen',
]
# openstackdocstheme options
repository_name = 'openstack/magnum'
bug_project = 'magnum'
bug_tag = ''
config_generator_config_file = '../../etc/magnum/magnum-config-generator.conf'
sample_config_basename = '_static/magnum'
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable

View File

@ -0,0 +1,7 @@
Sample Configuration File
-------------------------
.. toctree::
:maxdepth: 1
sample-config

View File

@ -0,0 +1,13 @@
============================
Magnum Configuration Options
============================
The following is a sample Magnum configuration for adaptation and use. It is
auto-generated from Magnum when this documentation is built, so
if you are having issues with an option, please compare your version of
Magnum with the version of this documentation.
The sample configuration can also be viewed in :download:`file form
</_static/magnum.conf.sample>`.
.. literalinclude:: /_static/magnum.conf.sample

View File

@ -82,6 +82,14 @@ Installation Guide
install/index
Sample Configurations
=====================
.. toctree::
:maxdepth: 1
configuration/index
Work In Progress
================