esfinge-http-dominio es un plugin Esfinge para agregar un dominio HTTP, permitiendo que la documentación de los métodos HTTP RESTful.
Puede documentar métodos sencillos, envuelva ningún argumento en el camino con rizado-llaves:
.. Http: Método :: GET / api / foo / bar / {id} / {} babosa
& Nbsp;: id arg: un ID
& Nbsp;: arg babosa: Una babosa
& Nbsp; Recuperar lista de foobars a juego Identificación del dado.
Parámetros de cadena de consulta también son compatibles:
.. Http: método :: GET / api / foo / bar / Identificación
& Nbsp;: id param: un ID
& Nbsp; buscar una lista de foobars a juego Identificación del dado.
Esto es muy rudimentaria y el código experimental en este momento.
Instalación
Ejecute pip instalar esfinge-http-dominio.
A continuación, agregue sphinx_http_domain a tu conf.py:
extensiones = ['sphinx_http_domain']
Requisitos
- Python
- esfinge
Comentarios que no se encuentran