mperrin / poppy

Physical Optics Propagation in Python
BSD 3-Clause "New" or "Revised" License
177 stars 41 forks source link

Migration to ReadTheDocs #232

Closed josePhoenix closed 7 years ago

josePhoenix commented 7 years ago

It appears that https://pythonhosted.org/ quietly removed the ability to upload new ZIPs of documentation. 😿

ReadTheDocs.org is more featureful (in some ways), and more commonly used. The reason we weren't using it already is that (when we last checked) projects that depend on SciPy and NumPy wouldn't build correctly in their environment. This appears to be fixed now.

Migration Checklist

Built docs are at http://poppy-optics.readthedocs.io/en/latest/ for master and http://poppy-optics.readthedocs.io/en/stable/ for v0.6.0. (Unclear whether RTD sorted the tags and picks "stable" on its own...)

mperrin commented 7 years ago

Absolutely superb. I did not expect you to get this done so fast! I'll grant that deadlines are a good motivator, though!

I've just made a small tweak to the RTD config so the default docs shown at http://poppy-optics.readthedocs.io/ are the stable version rather than the latest.

mperrin commented 7 years ago

This is all working well now, except for the eventual deprecation and removal of the old docs on pythonhosted, which we're leaving in place for now intentionally.