search

jplusplus / detective.io

Detective.io is a platform that hosts your investigation and lets you make powerful queries to mine it. Simply describe your field of study and detective.io builds the input interface as well as a state-of-the-art front-end.
http://www.detective.io
GNU Lesser General Public License v3.0
139 stars 17 forks source link

Documenter l'API #127

Open pirhoo opened 10 years ago

pirhoo commented 10 years ago

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 commented 10 years ago

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 commented 10 years ago

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

pirhoo commented 10 years ago

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