History

Vishakha Agarwal ce4d065f23 Generate PDF documentation 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 - Download link of config_options, sample config and policy files are disabled for PDF doc as relative links do not make sense. - Pre-create the doc/build/pdf/_static directory as a workaround because sphinx_feature_classification.support_matrix extension is operating under the assumption that the _static directory already exist and trying to copy support-matrix.css into it. We need to remove this workaround once the problem in the support_matrix extension is fixed. - Use the toctree_only=True workaround to avoid TOC duplicate links. Change-Id: Ief8df5f6a5a22b8d0530458ac45f344a72cc3e49		2019-09-10 16:36:48 +09:00
..
ext	Replace support matrix ext with common library	2019-04-16 18:09:14 -07:00
source	Generate PDF documentation	2019-09-10 16:36:48 +09:00
Makefile	Align with project configs.	2012-03-01 11:42:42 -08:00
README.rst	Fixes documentation building	2013-12-13 02:47:37 +00:00
requirements.txt	Merge "Blacklist sphinx 2.1.0 (autodoc bug)"	2019-07-19 19:33:07 +00:00

Building Docs

Developer documentation is generated using Sphinx. To build this documentation, run the following from the root of the repository:

$ tox -e docs

The documentation will be built at doc/build/.