search

cloudant-labs / cloudant-python

Asynchronous Cloudant / CouchDB interface for Python
http://cloudant-labs.github.io/cloudant-python/
37 stars 17 forks source link

Generate some initial API docs #2

Closed BigBlueHat closed 10 years ago

BigBlueHat commented 10 years ago

Sphinx or Docco (Pycco) would be fab!

If we go with Sphinx, let's also get them up to readthedocs.org

garbados commented 10 years ago

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.

BigBlueHat commented 10 years ago

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.

garbados commented 10 years ago

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.

BigBlueHat commented 10 years ago

k. No worries. Maybe an API.md? :grin: or maybe I'm just being picky... :neckbeard:

ddemichele commented 10 years ago

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.

garbados commented 10 years ago

https://garbados.cloudant.com/cloudant-python/docs/index.html