search

radiasoft / rswarp

Python utilities specific to running Warp
Other
5 stars 5 forks source link

readthedocs is broken #5

Closed robnagler closed 6 years ago

robnagler commented 6 years ago

A user writes:

The link for the documentation is broken (http://rswarp.readthedocs.org/en/latest/). Can I load it from elsewhere?

bruhwiler commented 6 years ago

Are we planning to support ReadTheDocs for this repository?

robnagler commented 6 years ago

ReadTheDocs is fixed: http://rswarp.readthedocs.io

It wasn't set up properly. Also, had to add the GitHub hook manually. RTD didn't see the GH repo automatically. I think this is because no groups were listed as Admins, but even when I made a couple of our groups admins, it still didn't work. I installed the GH hook manually.

robnagler commented 6 years ago

@bruhwiler to answer your question, it's easy to setup, just follow the instructions in the PyKern Wiki:

https://github.com/radiasoft/pykern/wiki/CreatePythonProject#readthedocs