From baaf81bfeb5721c48df94fa451fb4f19f001591a Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 27 Nov 2012 19:13:55 -0500 Subject: [PATCH] Fixes to enable the jenkins doc job to work Some of our documentation dependencies were not listed in test-requires, so the venv environment in tox needs to be updated to include them. Then the build_sphinx command looks for configuration settings in setup.cfg, so those need to be added. When Sphinx runs in this way, it ends up creating RST files for every module it finds in the source tree so it can document the internal APIs. Those generated files can be ignored by git. Change-Id: I21b5f9c6c4d4201893bb3bf87f0b61a053b968f5 Signed-off-by: Doug Hellmann --- .gitignore | 1 + setup.cfg | 5 +++++ tox.ini | 3 +++ 3 files changed, 9 insertions(+) diff --git a/.gitignore b/.gitignore index 88e3a120..03506f39 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,4 @@ ChangeLog dist *.egg ceilometer/versioninfo +doc/source/api/*.rst diff --git a/setup.cfg b/setup.cfg index 8b94b513..d8b5960b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,3 +6,8 @@ cover-inclusive = true verbosity=2 detailed-errors=1 where=tests + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source diff --git a/tox.ini b/tox.ini index 03dc6b07..5f4682a0 100644 --- a/tox.ini +++ b/tox.ini @@ -24,6 +24,9 @@ deps = pep8==1.1 commands = pep8 --repeat --show-source ceilometer setup.py bin/ceilometer-agent-central bin/ceilometer-agent-compute bin/ceilometer-collector bin/ceilometer-api tests [testenv:venv] +deps = -r{toxinidir}/tools/test-requires + -r{toxinidir}/tools/pip-requires + sphinxcontrib-httpdomain commands = {posargs} [testenv:py26-folsom]