ycasg
commented
8 years ago The Sphynx setup was the default, so there was no particular reason for the inclusion of intersphynx. I didn't see any issues with build speed on my desktop (perhaps this is only a problem when internet connectivity is poor/missing.) Thanks for posting a better skeletal readme; I'll work on it some in my infinite spare time (tm).
I added a bunch of text to the readme to give people a bit more information about what PyNLO can do and how to install it. I basically just copied this from another project (PyAbel), so hopefully it sounds okay. Feel free to change it as you wish (or tell me to change it).
Additionally, I built the readme as part of the docs. This way, we can put a lot of the general information in the readme and it will also appear in the docs, saving us the trouble of re-typing all of this general information into another place in the docs. I think this is a good way to do it, because it synchronizes all of the general info between rtfd.org, pypi, and github.
Also, I removed sphinx.ext.intersphinx from the conf.py. Intersphinx is used for references to other docs outside of PyNLO. Do we need this? It makes the doc build stall for a long time if you have a bad internet connection, so if we can avoid using it, then this would be nice. You can always just put in a static http link in the docs if you want to refer to things elsewhere on the interwebs.