add documentation restructured text checker to test suite

[Gary Wilson]

Invalid restructured text in the documentation should be caught by the test suite and reported as errors. This would hopefully reduce the number of reST error tickets that seem to crop up pretty often.

[Marc Fargas]

Given that docs are being refactored I'm not sure if that should be 1.0 or post-1.0 unless such a test is fast to setup.
Note that it would also require docutils to be available on the buildbots.

But surely some kind of testing of docs/ should be done :)

[Eric Holscher]

This seems like something that might work better as a Sphinx plugin. I know that sphinx will alert us if our documentation is broken or missing, so it seems like this might be invalid these days.

Going to make this 1.3 and a DDN, though I think it should be wontfix'd.

[Russell Keith-Magee]

I agree with Eric. A "make html" build already reports errors, so we already have a way of detecting "failures" -- we just need to run it.

On top of that, a clean "make html" build takes quite a while. This means it isn't ideal for a unittest, which generally relies of having lots of tests that are quick to run.

If we're going to do this, it really should be done as a step in a buildbot/CI build system, not as a test in the test suite.

[Jacob]

Milestone 1.3 deleted