sphinx http-domaine est un plugin Sphinx à ajouter un domaine HTTP, permettant à la documentation des méthodes HTTP RESTful.
Vous pouvez documenter des méthodes simples, envelopper tous les arguments dans le chemin avec des accolades:
.. Http: méthode :: GET / api / foo / bar / {id} / {slug}
& Nbsp;: arg id: Un id
& Nbsp;: arg slug: Une limace
& Nbsp; liste des foobars correspondant id donnée Récupérer.
les paramètres de chaîne de requête sont également pris en charge:
.. Http:? :: Méthode GET / api / foo / bar / id
& Nbsp;: param id: Un id
& Nbsp; Rechercher une liste de foobars correspondant id donné.
Ceci est très rudimentaire et code expérimental pour le moment.
Installation
Exécutez pip installer sphinx http domaine.
Ensuite, ajoutez à votre sphinx_http_domain conf.py:
extensions = ['sphinx_http_domain']
Exigences :
- Python
- Sphinx
Commentaires non trouvées