cinder/doc/source/contributor/index.rst
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

2.0 KiB

Contributor Guide

In this section you will find information on how to contribute to Cinder. Content includes architectural overviews, tips and tricks for setting up a development environment, and information on Cinder's lower level programming APIs.

Programming HowTos and Tutorials

development.environment testing api_microversion_dev api_conditional_updates addmethod.openstackapi drivers high_availability gmr replication user_messages migration api.apache rolling.upgrades groups

Managing the Development Cycle

releasecycle

Documentation Contribution

documentation

Background Concepts for Cinder

architecture attach_detach_conventions attach_detach_conventions_v2 thin_provisioning threading i18n rpc

Other Resources

launchpad gerrit zuul releasenotes

Module Reference <api/modules>

html

Indices and tables

  • genindex
  • modindex
  • search