sphinx, buildbot (and code coverage). how do they integrate?

☆樱花仙子☆ 提交于 2019-12-22 10:47:23

问题


I have a not-so-small python package, with quite some history, documented with docstrings. During its development we introduced buildbot and later on Jenkins/Hudson. Recently I added a sphinx recipe to my buildbot.cfg, in order to collect the documentation from the sources and keep up to date web accessible docs.

so far, so good: each time I commit a change, Jenkins takes care of extensively checking the package, generating a very complete overview and updating our documentation site.

one of the sphinx extensions I enabled: coverage, for documentation coverage report, which is currently undocumented.

I execute sphinx in my buildbot-generated environment, and I don't seem to manage to include the coverage statistics in the sphinx-generated documentation site!

any hints?


回答1:


as stated on the sphinx.ext.coverage page, coverage is computed if one specifies the builder -b coverage.

the result is the file "python.txt", a ReST file. It is your task to integrate it in your own documentation.



来源:https://stackoverflow.com/questions/5179010/sphinx-buildbot-and-code-coverage-how-do-they-integrate

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!