152d5c359c
This is a follow-up patch for https://review.opendev.org/676730. In the TOC of the current PDF file [1], most contents related to user and admin guides are located under "For Contributors" section. This is weird. It happens because the latex builder constructs the document tree based on "toctree" directives even though they are marked as "hidden". This commit reorganizes "toctree" per section. The "toctree" directives must be placed at the end of individual sections. Otherwise, content of a last section and content just after "toctree" directive are concatenated into a same section in the rendered LaTeX document. This commit also improves the following as well: * Specify "openany" as "extraclassoptions" to skip blank pages along with "oneside" to use same page style for odd and even pages. * Set "tocdepth" and "secnumdepth" to 3 respectively. "tocdepth" controls the depth of TOC and "secnumdepth" controls the level of numbered sections in TOC. Note that this commit does not reorganize file structure under doc/source. I believe this should be done separately. [1] https://docs.openstack.org/nova/latest/doc-nova.pdf Change-Id: Ie9685e6a4798357d4979aa6b4ff8a03663a9c71c Story: 2006100 Task: 35140
78 lines
2.4 KiB
ReStructuredText
78 lines
2.4 KiB
ReStructuredText
===================
|
|
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 :doc:`Nova Admin
|
|
Guide </admin/index>`.
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
* :doc:`Configuration Guide </admin/configuration/index>`: Detailed
|
|
configuration guides for various parts of your 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.
|
|
|
|
.. only:: html
|
|
|
|
* :doc:`Sample Config File <sample-config>`: A sample config
|
|
file with inline documentation.
|
|
|
|
.. # NOTE(mriedem): This is the section where we hide things that we don't
|
|
# actually want in the table of contents but sphinx build would fail if
|
|
# they aren't in the toctree somewhere.
|
|
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
|
|
# keep the document structure in the PDF doc.
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
config
|
|
|
|
.. # NOTE(amotoki): Sample files are only available in HTML document.
|
|
# Inline sample files with literalinclude hit LaTeX processing error
|
|
# like TeX capacity exceeded and direct links are discouraged in PDF doc.
|
|
.. only:: html
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
sample-config
|
|
|
|
Policy
|
|
------
|
|
|
|
Nova, like most OpenStack projects, uses a policy language to restrict
|
|
permissions on REST API actions.
|
|
|
|
* :doc:`Policy Reference <policy>`: A complete reference of all
|
|
policy points in nova and what they impact.
|
|
|
|
.. only:: html
|
|
|
|
* :doc:`Sample Policy File <sample-policy>`: A sample nova
|
|
policy file with inline documentation.
|
|
|
|
.. # NOTE(mriedem): This is the section where we hide things that we don't
|
|
# actually want in the table of contents but sphinx build would fail if
|
|
# they aren't in the toctree somewhere.
|
|
.. # NOTE(amotoki): toctree needs to be placed at the end of the secion to
|
|
# keep the document structure in the PDF doc.
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
policy
|
|
|
|
.. # NOTE(amotoki): Sample files are only available in HTML document.
|
|
# Inline sample files with literalinclude hit LaTeX processing error
|
|
# like TeX capacity exceeded and direct links are discouraged in PDF doc.
|
|
.. only:: html
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
sample-policy
|