pombreda / pysal

Automatically exported from code.google.com/p/pysal
Other
0 stars 0 forks source link

Have Sphinx run doctests #123

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Doctests have been moved out of the integration testing framework and should be 
tested to ensure documentation is consistent.

Original issue reported on code.google.com by sjsrey on 3 Jan 2011 at 10:35

GoogleCodeExporter commented 9 years ago
Sphinx doctest extension looks for special, non-numpydoc markup we have not 
implemented. See here: 
http://sphinx.pocoo.org/ext/doctest.html#module-sphinx.ext.doctest

Additionally, all of our hard-coded docstring data paths assume running tests 
from the tests/ directory, while Sphinx *prefers* to be run from its quickstart 
directory. 

The solution was to use the recently modified/added testdocs.py on a daily 
basis when the docs are built. Comments welcome.

Original comment by phil.stp...@gmail.com on 4 Jan 2011 at 10:46

GoogleCodeExporter commented 9 years ago
Doctests are run daily when docs are built. Results are emailed to dev list.

Original comment by phil.stp...@gmail.com on 5 Jan 2011 at 7:04