circstat / pycircstat

Toolbox for circular statistics with Python
MIT License
157 stars 42 forks source link

Fix sphinx documentation for distributions #28

Closed matthias-k closed 9 years ago

matthias-k commented 9 years ago

This should fix the problem @fabiansinz told me about. We make use of mock modules to make sure the documentation compiles e.g. on the readthedocs servers without scipy etc. installed. This mechanism by default disables documentation for all classes that inherit from one of these mocked modules. One has to adapt docs/conf.py for each of the classes that need to be interitable; in this case:

sys.modules['scipy.stats'] = mock.Mock(rv_continuous=object)

We have to keep in mind that we might have do adapt the configuration further in future. Unfortunately build_sphinx does not fail, it just excludes the classes from the documentation.