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.

Sign up for GitHub

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

Jump to bottom

Documenter l'API #127

Open
pirhoo opened this issue Dec 4, 2013 · 4 comments
Open

Documenter l'API #127

pirhoo opened this issue Dec 4, 2013 · 4 comments

Comments

@pirhoo
Copy link
Collaborator

pirhoo commented Dec 4, 2013

No description provided.

@smkraus smkraus added this to the Documentation and compatibility milestone Jun 5, 2014
@pirhoo
Copy link
Collaborator Author

pirhoo commented Jun 27, 2014

Va falloir faire remonter un peu cette issue. Est ce que vous avez une préférence et/ou une recommandation pour documenter l'API ? Ping @paulloz @pbellon @vied12.

Sur un projet précédent on avait essayé d'utiliser Swagger sur Tastypie, c'est plutôt bien fait mais assez limité :
https://github.com/concentricsky/django-tastypie-swagger

Habituellement en python utilise Sphinx, je sais pas si c'est adapté pour une API :
http://sphinx-doc.org/

@paulloz
Copy link
Collaborator

paulloz commented Jun 27, 2014

Jamais utilisé autre chose que Sphinx pour écrire de la doc Python perso'.
Après faut déjà savoir si on veut de la doc générée ou pas...

@pirhoo
Copy link
Collaborator Author

pirhoo commented Jun 27, 2014

Il y a aussi Tastytools qui permet de générer de la doc pour Tastypie :
https://github.com/juanique/django-tastytools

@pirhoo
Copy link
Collaborator Author

pirhoo commented Jun 27, 2014

Y'a de l'autodoc sur Sphinx, c'est cool.

@pirhoo pirhoo self-assigned this Jul 2, 2014
@pirhoo pirhoo removed their assignment Jul 9, 2014
@smkraus smkraus removed this from the Documentation and compatibility milestone Aug 11, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@paulloz @pirhoo @smkraus