sphinx-http-domínio é um plugin Sphinx para adicionar um domínio HTTP, permitindo a documentação de métodos HTTP RESTful.
Você pode documentar métodos simples, envolva quaisquer argumentos no caminho por chavetas:
.. Http: method :: GET / api / foo / bar / {id} / {} lesma
& Nbsp;: id arg: Uma id
& Nbsp;: arg lesma: Uma bala
& Nbsp; lista de foobars correspondentes dado id Obter.
Parâmetros cadeia de consulta também são suportados:
.. Http:? Method :: GET / api / foo / bar / id
& Nbsp;: id param: Um id
& Nbsp; Procure uma lista de foobars correspondentes dado id.
Isto é muito rudimentar e código experimental no momento.
Instalação
Execute pip instalar sphinx-http-domínio.
Em seguida, adicione sphinx_http_domain ao seu conf.py:
extensões = ['sphinx_http_domain']
Requisitos :
- Python
- Sphinx
Comentários não encontrado