diff options
| author | Akihiro Motoki <amotoki@gmail.com> | 2019-08-16 00:52:14 +0900 |
|---|---|---|
| committer | Akihiro Motoki <amotoki@gmail.com> | 2019-09-04 17:34:26 +0900 |
| commit | 16b9486bf7e91bfd5dc48297cee9f54b49156c93 (patch) | |
| tree | 230748e09492b40c6ff01c6aba7a8c81ca57bad0 /doc/requirements.txt | |
| parent | 872a823d9a02f31e266882bfb499673c51fb4075 (diff) | |
| download | nova-16b9486bf7e91bfd5dc48297cee9f54b49156c93.tar.gz | |
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
Diffstat (limited to 'doc/requirements.txt')
| -rw-r--r-- | doc/requirements.txt | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index c134946f81..c0a868a619 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,9 +2,10 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD -sphinx>=1.8.0;python_version>='3.4' # BSD +sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD sphinxcontrib-actdiag>=0.8.5 # BSD sphinxcontrib-seqdiag>=0.8.4 # BSD +sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD sphinx-feature-classification>=0.2.0 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 openstackdocstheme>=1.30.0 # Apache-2.0 |