Arthur Dayne 31d23b7315 Generate PDF documentation

- 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.
- Specify openany in extraclassoptions to skip blank pages
  (oneside is also specified to use the same page layout
   for even and odd pages)
- tocdepth is set to 2 for better PDF TOC
- printindex and makeindex are set to empty in latex_elements
  to avoid an empty "Index" section in PDF
- 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: I70100a71114e1d75833e6c783086325baa0e3fd2

2020-03-21 15:02:55 +00:00

797 B

Raw Blame History

Cyborg Configuration Sample

latex

Sample configuration files for all Cyborg services are found in the online version of this documentation.

html

The following is a sample cyborg configuration for adaptation and use. It is auto-generated from cyborg when this documentation is built, so if you are having issues with an option, please compare your version of cyborg with the version of this documentation.

The sample configuration can also be downloaded in file form.

../_static/cyborg.conf.sample

797 B Raw Blame History

Cyborg Configuration Sample

797 B

Raw Blame History