sphinxcontrib-hydradoc

Sphinx est un système de génération de documentation très utilisé dans le monde python.

Hydra est un langage, basé sur JSON (et JSON-LD, W3C Recommendation) pour décrire une API REST sous une forme exploitable par les machines. À titre d'exemple, cette description Hydra décrit un service de bug-tracking. Une démo exploitant cette description est également disponible ici: demo. Il est important de noter que la console utilisée dans cette démo est totalement générique, n'ayant aucune connaissance a priori sur le service auquel elle se connecte.

Dans la partie droite de la console apparaît une documentation lisible du service, générée à partir de la description Hydra. L'objectif de ce Spint est de développer un module Sphinx permettant de générer avec Sphinx le même type de documentation à partir d'une description Hydra.

TODO

• Si on prend un fichier Hydra en entrée, déterminer le path exact, l'utilisateur donne juste le nom du fichier
• Pouvoir mettre une uri vers la description Hydra
• Définir les options de la ou des directive(s)

Développement

Pour aider le développement de cette extension nous conseillons la lecture de ces documentation :

• http://sphinx-doc.org/extdev/
• http://sphinx-doc.org/extdev/tutorial.html
• http://sphinx-doc.org/extdev/appapi.html
• https://github.com/thewtex/sphinx-contrib
• https://github.com/felipeblassioli/sphinx_autoflask