chris-hld / spaudiopy

Spatial Audio Python Package
https://spaudiopy.readthedocs.io/
MIT License
143 stars 15 forks source link

Doc update and switch to pip #8

Closed chris-hld closed 4 years ago

chris-hld commented 4 years ago

Seems that Sphinx > 3.0 is incompatible with current Matplotlib 3.0. sphinx extension.

However, we have to use Matplotlib < 3.1 because the 3D set aspect issue is still not fixed and critical for spherical plots. Newest issue here: https://github.com/matplotlib/matplotlib/issues/17172

Using sphinx with anaconda overwrites the sphinx version specified in the Conda environment. https://github.com/readthedocs/readthedocs.org/issues/3829

So currently the best option to pin versions and ensure a working doc is to use pip. Additionally, the build process seems to be a lot faster on RTD (about half the time).