openstack/nova
Code Issues Proposed changes
nova/doc
History
Akihiro Motoki 16b9486bf7 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-09-04 17:34:26 +09:00
..
api_samples
Multiple API cleanup changes
2019-08-12 08:52:38 -05:00
ext
Replace support matrix ext with common library
2018-07-16 15:04:00 +01:00
notification_samples
Merge "Enhance service restart in functional env"
2019-06-27 17:50:19 +00:00
source
PDF documentation build
2019-09-04 17:34:26 +09:00
test
docs: Rework all things metadata'y
2019-06-20 18:22:34 +01:00
README.rst
Update api-ref location
2019-07-22 19:17:28 +02:00
requirements.txt
PDF documentation build
2019-09-04 17:34:26 +09:00

README.rst

OpenStack Nova Documentation README

Both contributor developer documentation and REST API documentation are sourced here.

Contributor developer docs are built to: https://docs.openstack.org/nova/latest/

API guide docs are built to: https://docs.openstack.org/api-guide/compute/

For more details, see the "Building the Documentation" section of doc/source/contributor/development-environment.rst.