Sphinx, buildbot (and code coverage). How do they integrate?

Question

I have a not-so-small python package with a fairly specific history, documented using docstrings. During our development, we introduced buildbot , and then Jenkins / Hudson . I recently added sphinx to my buildbot.cfg to collect documentation from sources and update documents available on the Internet.

it’s still so good: every time I make changes, Jenkins takes care of thoroughly checking the package, generating a very complete overview and updating our documentation site.

one of the sphinx extensions that I allowed: coverage , for a documentation coverage report that is currently undocumented.

I am running sphinx in my buildbot-created environment, and it seems that I am unable to include coverage statistics on the documentation site generated by sphinx!

any clues?

Answer 1

as indicated on the sphinx.ext.coverage page, coverage is calculated by specifying the -b coverage constructor.

the result is a "python.txt" file, a REST file. Your task is to integrate it into your documentation.