Rough skeleton of documentation (by Sphinx)

[csyhuang]

Addressing issue #88

Everything generated by Sphinx for the python package is in py-pkg/docs/

Thanks for the fun night!

[codecov-io]

Codecov Report

Merging #130 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #130   +/-   ##
=======================================
  Coverage   95.23%   95.23%           
=======================================
  Files           8        8           
  Lines         608      608           
=======================================
  Hits          579      579           
  Misses         29       29

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 58a5460...fe5c754. Read the comment docs.

[jameslamb]

Thanks for doing this, it looks awesome! Can you please do three things:

• remove all the files in build/. For now, until we figure out a strategy to merge our R and Python docs on github-pages, I do not want to check all that HTML into the repo
• add py-pkg/docs/build/ to .gitignore so no future committers accidentally check these files in
• add a docs_python recipe to the Makefile at the repo root (NOT the Sphinx makefile) containing whatever commands are needed to regenerate the docs. Should be something like cd py-pkg/docs && make html, I think

Once you make those changes, I think it will be good to merge!

[csyhuang]

Hi @jameslamb ,

Thanks for the note. I've made the changes accordingly - seems that I cannot submit another pull request on top of the existing one. Can the branch be merged? Is there anything to be added?

Best,

Clare

[jameslamb]

@csyhuang FYI in case you noticed Travis breaking on your most recent commit...not related to your code at all. Sometimes Travis builds just randomly fail because of network problems. I manually rebuilt it and it looks good.

[jameslamb]

Thanks so much for doing this!!!

I cloned your branch and built locally, can confirm it all works! I'm going to create a few more issues on the project for things like updating the style, adding explicit author names to the copyright statement, etc. so if you're interested we'd welcome further contributions.

But this PR as-is definitely addresses the issue. Really really appreciate you spending the time improving our project!!!!

[jameslamb]

I think Sphinx will recognize lines like this broken by explicit newlines, e.g. putting a \n at the end of each line.

But I have no strong preference between doing that and what you did here, so this is cool!