openstack
/
placement
Code Issues Proposed changes

Make config docs build 

Add sphinx configuration and doc stubs/references to make
doc/build/html/configuration/config.html and its brethren happen.

Change-Id: Ieb16dbc2a7e67cb84b7098133be24fcc860312cd
This commit is contained in:
Eric Fried 2018-09-13 10:29:32 -06:00 committed by Chris Dent
parent f5a25d5fd6
commit 9705e88fb5
5 changed files with 43 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/conf.py
View File

@ -43,8 +43,7 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.graphviz',
'sphinx_feature_classification.support_matrix',
# TODO(efried): make this work
# 'oslo_config.sphinxconfiggen',
'oslo_config.sphinxconfiggen',
'oslo_config.sphinxext',
'oslo_policy.sphinxpolicygen',
'oslo_policy.sphinxext',
@ -57,6 +56,9 @@ repository_name = 'openstack/placement'
bug_project = 'nova'
bug_tag = 'docs'
config_generator_config_file = '../../etc/placement/config-generator.conf'
sample_config_basename = '_static/placement'
policy_generator_config_file = [
('../../etc/placement/policy-generator.conf',
'_static/placement')

10
doc/source/configuration/config.rst Normal file
View File

@ -0,0 +1,10 @@
=====================
Configuration Options
=====================
The following is an overview of all available configuration options in
Placement. For a sample configuration file, refer to
:doc:`/configuration/sample-config`.
.. show-options::
:config-file: etc/placement/config-generator.conf

20
doc/source/configuration/index.rst
View File

@ -2,22 +2,22 @@
Configuration Guide
===================
The static configuration for nova lives in two main files: ``nova.conf`` and
``policy.json``. These are described below. For a bigger picture view on
configuring nova to solve specific problems, refer to the :nova-doc:`Nova Admin
Guide </admin/index>`.
The static configuration for Placement lives in two main files: ``placement.conf`` and
``policy.json``. These are described below.
Configuration
-------------
.. TODO(efried):: Get these working
* :doc:`Config Reference <config>`: A complete reference of all
configuration options available in the ``placement.conf`` file.
* :doc:`Sample Config File <sample-config>`: A sample config
file with inline documentation.
.. TODO(efried):: Get this working
* :nova-doc:`Configuration Guide </admin/configuration/index>`: Detailed
configuration guides for various parts of you Nova system. Helpful reference
for setting up specific hypervisor backends.
* :doc:`Config Reference <config>`: A complete reference of all
configuration options available in the ``nova.conf`` file.
* :doc:`Sample Config File <sample-config>`: A sample config
file with inline documentation.
Policy
------
@ -40,7 +40,5 @@ permissions on REST API actions.
policy
sample-policy
.. TODO(efried):: get these working
config
sample-config

19
doc/source/configuration/sample-config.rst Normal file
View File

@ -0,0 +1,19 @@
=========================
Sample Configuration File
=========================
The following is a sample Placement configuration for adaptation and use. For a
detailed overview of all available configuration options, refer to
:doc:`/configuration/config`.
The sample configuration can also be viewed in :download:`file form
</_static/placement.conf.sample>`.
.. important::
The sample configuration file is auto-generated from placement when this
documentation is built. You must ensure your version of placement matches
the version of this documentation.
.. literalinclude:: /_static/placement.conf.sample

2
doc/source/index.rst
View File

@ -340,7 +340,7 @@ could be making requests to a Newton placement API.
Configuration
~~~~~~~~~~~~~
See the `Configuration Guide <configuration/index>` for information on
See the :doc:`Configuration Guide <configuration/index>` for information on
configuring the system, including role-based access control policy rules.
Contributors