Generate some initial API docs
Closed this issue · 6 comments
Sphinx or Docco (Pycco) would be fab!
If we go with Sphinx, let's also get them up to readthedocs.org
You mean a dedicated website, rather than this?
Since Sphinx hates Markdown, I'll probably generate a static site and deploy that from some branch, Github-Pages style.
Ah...forgot about the "Sphinx hates Markdown" bit...sad...for them. I did find the API docs in the README after I posted this issue. I'd personally prefer them separate, so the README stays lighter weight.
I'd checked under docs and the Wiki before filing this issue--after which I found them in the README. Just not where I look, I guess.
Yeah, the docs folder contains the script and template used to create the README from the docstrings in the project's parts. I'll try Pycco and see what happens.
k. No worries. Maybe an API.md? 😁 or maybe I'm just being picky... 
Also FWIW I think the Readme should have connection examples like the blog post.
On Nov 5, 2013, at 1:54 PM, BigBlueHat notifications@github.com wrote:
Ah...forgot about the "Sphinx hates Markdown" bit...sad...for them. I did find the API docs in the README after I posted this issue. I'd personally prefer them separate, so the README stays lighter weight.
I'd checked under docs and the Wiki before filing this issue--after which I found them in the README. Just not where I look, I guess.
—
Reply to this email directly or view it on GitHub.