History

Andreas Jaeger cebed4114b Docs: Make robust with using real links This backport squashes `f10f95b` and the correction `4ed39d5`. Our tools noticed that keystone links to https://docs.openstack.org/keystone/latest/admin/identity-domain-specific-config.html which does not exist anymore. The page was removed but the link to it was not changed. Replace this and similar links with internal links that will work even if files are moved - and can be verified, thus sphinx will error in case of broken targets. These changes include a few other fixes for broken keystone links, e.g. to renamed anchors. For the include files in admin/configuration.rst and admin/federation/configure_federation.rst: Rename them to *inc. The files were published twice (as separate files and on this page) and thus referencing failed. Renaming avoids this. Also, put doctree outside of html tree so that it does not get published. (cherry picked from commit `f10f95b455`) Fix relative links Fix minor errors introduced in `f10f95b4`. (cherry picked from commit `4ed39d530f`) Change-Id: I3d07637b0046cc88a66bcb51a0a4fe7c146c1549		2019-10-18 09:13:36 -07:00
..
ext	Fix doc generation for python 3	2017-04-17 07:44:47 +02:00
source	Docs: Make robust with using real links	2019-10-18 09:13:36 -07: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	Add introduction section to federation docs	2018-12-11 15:37:06 +01: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/.