https://github.com/fconil/sphinxcontrib-hydradoc
sphi
https://github.com/fconil/sphinxcontrib-hydradoc
Last synced: 1 day ago
JSON representation
sphi
- Host: GitHub
- URL: https://github.com/fconil/sphinxcontrib-hydradoc
- Owner: fconil
- License: lgpl-2.1
- Created: 2014-10-27T13:20:24.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-10-30T14:32:15.000Z (over 11 years ago)
- Last Synced: 2026-06-29T04:36:19.708Z (1 day ago)
- Language: Python
- Size: 188 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
sphinxcontrib-hydradoc
======================
[Sphinx](http://sphinx-doc.org/contents.html) est un système de génération de documentation très utilisé dans le monde python.
[Hydra](http://www.hydra-cg.com/) est un langage, basé sur JSON (et [JSON-LD](http://json-ld.org/), [W3C Recommendation](http://www.w3.org/TR/json-ld/)) pour décrire une API REST sous une forme exploitable par les machines. À titre d'exemple, cette [description Hydra](http://www.markus-lanthaler.com/hydra/api-demo/vocab) décrit un service de bug-tracking. Une démo exploitant cette description est également disponible ici: [demo](http://www.markus-lanthaler.com/hydra/console/?url=http://www.markus-lanthaler.com/hydra/api-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
----
- [X] Si on prend un **fichier** Hydra en entrée, déterminer le path exact, l'utilisateur donne juste le nom du fichier
- [X] Pouvoir mettre une **uri** vers la description Hydra
- [X] 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