Autogenerate config options and sample config file
This patch adds to "docs" tox job ability to automatically generate sample config file and config reference based on config options defined in code. Change-Id: Id960cc28d1b13ef3ed15e911f59620afb83f45b9changes/69/671469/3
parent
828f8a420b
commit
d050e3399a
@ -0,0 +1,25 @@
|
||||
.. _configuring:
|
||||
|
||||
=============================
|
||||
Tobiko Configuration Options
|
||||
=============================
|
||||
|
||||
This section provides a list of all configuration options for Tobiko.
|
||||
These are auto-generated from Tobiko code when this documentation is
|
||||
built.
|
||||
|
||||
Configuration Reference
|
||||
-----------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
tobiko.rst
|
||||
|
||||
Sample Configuration Files
|
||||
--------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
samples/tobiko.rst
|
@ -0,0 +1,8 @@
|
||||
===================
|
||||
Sample tobiko.conf
|
||||
===================
|
||||
|
||||
This sample configuration can also be viewed in `the raw format
|
||||
<../../_static/config-samples/tobiko.conf.sample>`_.
|
||||
|
||||
.. literalinclude:: ../../_static/config-samples/tobiko.conf.sample
|
@ -0,0 +1,6 @@
|
||||
===========
|
||||
tobiko.conf
|
||||
===========
|
||||
|
||||
.. show-options::
|
||||
:config-file: etc/oslo-config-generator/tobiko.conf
|
@ -0,0 +1,5 @@
|
||||
[DEFAULT]
|
||||
output_file = etc/tobiko.conf.sample
|
||||
wrap_width = 79
|
||||
|
||||
namespace = tobiko
|
Loading…
Reference in New Issue