History

Walter A. Boring IV e10b094db4 Add pdf documentation build in tox

This patch adds a new tox job/command for building the pdf version
of documentation.

tox -epdf-docs

In addition to adjusting the infra requirement for PDF build support,
the following changes are made to build a PDF doc.

- Inline sample config file is skipped for PDF doc
  to avoid an LaTeX error "TeX capacity exceeded".
- Download link of sample config and policy files are disabled
  for PDF doc as relative links do not make sense.
- "Search" and "genindex" page is only enabled for HTML doc
  as they work only for HTML doc.

Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: Ib8ce96f4d043dcf0cfe6d3f8b64879f07bc5958c

2019-08-28 20:37:56 +00:00

ext

Launch driver list generation with the same python interpreter

2019-06-28 19:07:22 +02:00

source

Add pdf documentation build in tox

2019-08-28 20:37:56 +00:00

.gitignore

Make doc/source directory compliant with design in spec

2017-07-19 15:59:02 -05:00

README.rst

Update and replace http with https for doc links in Cinder

2017-07-27 09:58:23 +00:00

requirements.txt

Update docs building

2019-08-10 11:41:14 +02:00

README.rst

Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

Developer documentation is built to: https://docs.openstack.org/cinder/latest/

Tools

Sphinx: The Python Sphinx package is used to generate the documentation output. Information on Sphinx, including formatting information for RST source files, can be found in the Sphinx online documentation.
Graphviz: Some of the diagrams are generated using the dot language from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.

Building Documentation

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs