openstack/nova
Code Issues Proposed changes
d4af91f349
nova/doc/source/configuration/config.rst

13 lines
300 B
ReStructuredText
Raw Normal View History

doc: Start using oslo_config.sphinxext Providing a sample configuration file is all well and good, but it's not exactly designed for readability on the web. Make use of the 'sphinxext' module built into oslo.config to do this. Change-Id: I75e8f0adae7cfaaa6020870cdb20dc2144fc70eb
2017-08-03 16:24:53 +01:00
=====================
Configuration Options
=====================
The following is an overview of all available configuration options in Nova.
PDF documentation build - Add a new pdf-docs environment to enable PDF build. - sphinxcontrib-svg2pdfconverter is used to handle SVG properly. - maxlistdepth=10 in latex_elements is needed to handle deeper levels of nesting. - Sample config/policy files are skipped in the PDF document as inline sample files cause LaTeX error [1] and direct links in PDF doc is discouraged. Note that sample-config and sample-policy need to be excluded to avoid the LaTeX error [1] and :orphan: is specified in those files. [1] https://github.com/sphinx-doc/sphinx/issues/3099 Change-Id: I3aaea1d15a357f550f529beaa84fb1a1a7748358
2019-08-16 00:52:14 +09:00
.. only:: html
For a sample configuration file, refer to :doc:`sample-config`.
doc: Start using oslo_config.sphinxext Providing a sample configuration file is all well and good, but it's not exactly designed for readability on the web. Make use of the 'sphinxext' module built into oslo.config to do this. Change-Id: I75e8f0adae7cfaaa6020870cdb20dc2144fc70eb
2017-08-03 16:24:53 +01:00
.. show-options::
:config-file: etc/nova/nova-config-generator.conf
Copy Permalink