Skip to content
This repository has been archived by the owner on Mar 5, 2018. It is now read-only.

Create real api docs with Sphinx #34

Closed
deontologician opened this issue Mar 9, 2015 · 4 comments
Closed

Create real api docs with Sphinx #34

deontologician opened this issue Mar 9, 2015 · 4 comments

Comments

@deontologician
Copy link
Owner

Right now, the readme is bending under its own weight, and there are many undocumented pieces of the api.

@bubenkoff
Copy link
Collaborator

I can work on that to integrate it with readthedocs, if you'll create a
project for rest navigator there and add me as a collaborator (bubenkoff)

On 9 March 2015 at 06:35, Josh Kuhn notifications@github.com wrote:

Right now, the readme is bending under its own weight, and there are many
undocumented pieces of the api.


Reply to this email directly or view it on GitHub
#34.

Anatoly Bubenkov

@deontologician
Copy link
Owner Author

Done.

@bubenkoff
Copy link
Collaborator

Is this http://rest-navigator.readthedocs.org/en/latest/#module-restnavigator enough or you wanted something more?

@deontologician
Copy link
Owner Author

That looks pretty good to me. I might comb through it later, but since it's automatically building from docstrings it can be fixed up if I notice the docstrings aren't descriptive enough

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants