Move WebbPSF docs to pythonhosted.org

[josePhoenix]

I noticed that the current docs at http://www.stsci.edu/~mperrin/software/webbpsf/ are being served with incorrect encoding information. (Note the appearance of the paragraph links that appear when mousing over headings.)

While we could probably fix that with a .htaccess change, it might be worth moving the docs to a service like readthedocs.org (which AstroPy) uses. Then we can build docs from the development head automatically, as well as from the latest stable release.

[mperrin]

I moved the poppy docs to the pythonhosted.org site that is integrated with PyPI. See https://pythonhosted.org/poppy/ . Whenever we make a new release of webbpsf we should certainly do the same with that.

Do you know of any specific advantages of readthedocs over pythonhosted?

[josePhoenix]

I need to do some research, but the thing I liked about readthedocs is that you can have new commits on master trigger a build of the docs. That way if we have a development version, we can actually have docs online for that version AND the released version.

Do you know if that's possible with PyPI/pythonhosted?

[mperrin]

Pythonhosted is manual, whenever you upload a new package version to pypi. It doesn't automatically track master. I agree that readthedocs would be nice for the github tracking. I even started to create an account at one point to try to figure out how to set this up, but got distracted before I was able to carry through on that. There exist projects for both poppy and webbpsf projects on readthedocs but they're broken and not building right now.

Let me see if I can grant you access - do you have an account for readthedocs yet?

On Oct 31, 2014, at 1:43 PM, Joseph Long <notifications@github.commailto:notifications@github.com>
wrote:

I need to do some research, but the thing I liked about readthedocs is that you can have new commits on master trigger a build of the docs. That way if we have a development version, we can actually have docs online for that version AND the released version.

Do you know if that's possible with PyPI/pythonhosted?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/20#issuecomment-61299211.

[josePhoenix]

Just made one! Same username as here: josePhoenix

[mperrin]

OK, I've just added you to the two projects on readthedocs.

[josePhoenix]

Per our discussion (and me bugging the ReadTheDocs folks) it looks like the service isn't mature enough to handle scientific python packages. Let's do pythonhosted.org for WebbPSF when we make a new release.

[josePhoenix]

Uploaded the latest built from my docs_refresh branch. Will need to update when we actually release 0.3, but that's just a matter of uploading a new .zip file.

https://pythonhosted.org/webbpsf/