History

wangxiyuan 488ecef329 Fix warnings in documentation A recent change defaults the warning-as-error to True: https://review.openstack.org/#/c/559348/ Which is causing our documentation jobs to fail locally and in the gate/check queues. This commit fixes both issues that are causing failures so that we can get the doc jobs passing again. Closes-Bug: 1774508 Change-Id: Ic1eff48a6f40aa315cc5e566a0f9e930a20b9837		2018-05-31 21:28:41 +00:00
..
ext	Fix doc generation for python 3	2017-04-17 07:44:47 +02:00
source	Fix warnings in documentation	2018-05-31 21:28:41 +00: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	Fix warnings in documentation	2018-05-31 21:28:41 +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/.