Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the doc #57

Open
johnraz opened this issue Feb 27, 2014 · 2 comments
Open

Improve the doc #57

johnraz opened this issue Feb 27, 2014 · 2 comments

Comments

@johnraz
Copy link
Contributor

johnraz commented Feb 27, 2014

We should build a decent sphinx doc and host it @ readthedocs.org.

We should cover:
*Requirements & dependencies
*Install
*Usage / Available options + examples

@krimkus
Copy link
Contributor

krimkus commented Mar 5, 2014

I have added this project to readthedocs.org:
http://django-tastypie-swagger.readthedocs.org/en/latest/

That will automatically pull the .rst files from the /docs/ folder, which I added to this repo. Currently, the only file is a mostly empty index file. But it is ready to go if anyone wants to paste and restructure the README content into the index.rst and build a table of contents pointing to other files. Check out the sphinx tutorial for help.

I will eventually get to this if no one else does first. If the docs don't automatically get built as we push version tags to this repo, I might have to add some sort of git hook to make that happen.

@johnraz
Copy link
Contributor Author

johnraz commented Mar 5, 2014

Awesome, thanks :)

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

No branches or pull requests

2 participants