Commit Graph

5 Commits

Author SHA1 Message Date
Sean Mooney 380c2287ad convert docs to PTI
This change converts the repo to the new PTI workflow
and modernises the docs by using the OpenStack docs theme.

Change-Id: I5a3706c7cf40ee0c3405131b89f956bf75cae244
2018-09-20 06:22:02 +00:00
Matt Riedemann 9f44f79a2d Fix the module index link in the docs
Since we weren't autodoc'ing the modules during the docs build, the
module index link was broken.

This generates the module docs (but hides them from the main top-level
table of contents) so they can be accessed via the 'Module Index' link.

Also cleans up some docs issues so that warnerrors=True works during
sphinx-build.

Closes-Bug: #1472642

Change-Id: I5a3a16d1e81b12237452d5a3a3f7f0cc42618e88
2015-07-08 07:54:23 -07:00
Andreas Jaeger 67f1a11b96 Stop using intersphinx
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
2014-09-13 09:51:02 +02:00
Clark Boylan efc5f0f09f Document adding bug signatures to e-r.
Add a section to the README.rst that covers the process to add
bug signatures to elastic-recheck.

Change-Id: I93c830d8d2f414f5f52ae907e2a38a2a681c7534
Closes-bug: 1172387
2013-12-12 12:34:54 -08:00
Joe Gordon 639697808e Apply Cookiecutter to the repo.
Make repo support 'tox -epep8' as we want this to be the first gating
check.
Don't make any actual code changes, just change setup and add files.
Further work is needed to re-organize the code, but that can be in a
separate patch.
2013-09-23 15:27:39 -07:00