Je suis à la recherche d'un thème Wordpress, ou simplement des CSS, images et HTML bruts d'un modèle de document d'API à utiliser. Je suis en train de construire une API RESTFul, et j'ai besoin de créer de la documentation, et je voudrais éviter d'écrire notre propre modèle de doc API. Je n'ai pas besoin d'une documentation générée automatiquement, mais simplement d'un thème/template API Doc très esthétique.
J'aime beaucoup le Mozilla Doc API
De plus, Postmark a de superbes Doc API également
Swagger est un cadre de documentation d'API/Sandbox très cool. Vous pouvez trouver plus d'informations ici : http://swagger.wordnik.com/
--UPDATE--
Il existe également un excellent projet open-source appelé Schéma directeur de l'API qui utilise une version spéciale de Markdown. L'avantage de ce projet est que d'autres projets peuvent analyser ces fichiers et créer des solutions de documentation convaincantes. Rucher maintient le projet et dispose de sa propre solution de documentation API complète. Une autre solution (plus simple) qui utilise API Blueprint est la suivante Aglio .
Je suppose que puisque je parle de l'API Blueprint, je pourrais aussi bien mentionner RAML aussi. Il est similaire à API Blueprint car c'est un langage que d'autres projets peuvent analyser pour créer de la documentation. Je n'ai pas utilisé RAML, mais mon évaluation en 5 minutes est qu'il n'est pas aussi facile à utiliser que API Blueprint.
Voici un modèle google docs fait pour les docs API http://rebugged.com/web-service-api-specification-doc-template/
(Vous devez être connecté à votre compte gmail - pas à google apps - pour prévisualiser le modèle)
Je suis d'accord en ce qui concerne Sphinx - et en fait, la documentation de postmarkapp ressemble beaucoup à la sortie d'un de ces thèmes Sphinx :
Le point commun est qu'ils utilisent Bootstrap de Twitter qui regroupe un cadre HTML5 + CSS + Javascript léger très bien conçu.
J'ai cependant quelques réserves à formuler à l'égard de Sphinx : certains des éléments de sa documentation sont codés en dur dans son rédacteur HTML4+CSS2. Et la seule façon de le plier à votre volonté est soit de creuser profondément dans les entrailles de Sphinx et de changer la façon dont il fonctionne - soit de faire un post-traitement affreux du HTML de sortie en utilisant des filtres de contenu dans l'interface de Sphinx. Jinja2 langage de modélisation.
Croyez-moi sur ce point - ne vous faites pas d'idée en modifiant Sphinx - contentez-vous de post-traiter le HTML. Cela vous fera gagner beaucoup de temps.
Alternativement
Vous pouvez toujours emprunter la voie de Doxygen. Il existe un thème CSS. doxyclean qui produit une documentation API similaire à celle d'Apple. Il a 3 ans, donc il y a peut-être quelque chose de mieux. (Diable, il pourrait même y avoir un thème Doxygen-bootstrap à ce stade )
Avez-vous regardé le Thèmes du Sphinx ? La source est sur BitBucket et est sous la licence BSD. Vous voudrez peut-être vérifier avec eux l'utilisation des graphiques qu'ils incluent, mais vous devriez pouvoir l'utiliser comme point de départ. Sphinx est également un excellent outil de documentation.
Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.
