Stack Club notebooks on RTD

drphilmarshall commented 5 years ago

Just to get started, I re-made the docs/index.rst file as a global Stack Club home page, and moved the stackclub package API docs to a separate RST file. Next up I'll try to bring in the notebooks. This is not ready for review yet - but I'll keep you posted, and log my progress on issue #164 in this PR thread.

drphilmarshall commented 5 years ago

OK, here's a first pass at a comprehensive Stack Club RTD site: https://stackclub.readthedocs.io/en/project-rtd-drphilmarshall/

[X] The tables are coming out too wide. I fixed this in the local Sphinx config.py file, but apparently RTD is not picking that up yet. Update: Done!
[X] To get the beavis-ci badges to show up in Sphinx-made webpages, they need to be PNG not SVG. I have submitted an upgrade here, and will run beavis-ci.sh --png as soon as I can. Update: Done!

I figured it might be useful to have all our notebooks on one long webpage. Comments welcome on this design, or any other aspect of the RTD site. What else do we want up there? Pinging @kadrlica and @Madejski as reviewers, but all of you in the @LSSTScienceCollaborations/stack-club should feel free to comment, this is your product we are delivering :-)

drphilmarshall commented 5 years ago

Uh-oh - I should have chased my reviewers! I'm going to go ahead and merge this, and then accept issues requesting improvements to the readthedocs pages. Hope that's OK, @kadrlica @Madejski !

kadrlica commented 5 years ago

Yep, sounds good to me. I did look through the RTD, but not in enough detail to claim that I reviewed it.

LSSTScienceCollaborations / StackClub

Stack Club notebooks on RTD #165