openstack/deb-ceilometer
Code Issues Proposed changes

Fixes to enable the jenkins doc job to work

Browse Source 
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 <doug.hellmann@dreamhost.com>
This commit is contained in:
Doug Hellmann 2012-11-27 19:13:55 -05:00
parent 4f7bb48bc5
commit baaf81bfeb
3 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -12,3 +12,4 @@ ChangeLog
dist dist
*.egg *.egg
ceilometer/versioninfo ceilometer/versioninfo
doc/source/api/*.rst

5
setup.cfg
View File

@ -6,3 +6,8 @@ cover-inclusive = true
verbosity=2 verbosity=2
detailed-errors=1 detailed-errors=1
where=tests where=tests
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source

3
tox.ini
View File

@ -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 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] [testenv:venv]
deps = -r{toxinidir}/tools/test-requires
-r{toxinidir}/tools/pip-requires
sphinxcontrib-httpdomain
commands = {posargs} commands = {posargs}
[testenv:py26-folsom] [testenv:py26-folsom]