sphinx-http-domain

sfinge-http-dominio è un plugin Sfinge per aggiungere un settore HTTP, che permette la documentazione dei metodi HTTP RESTful.
È possibile documentare metodi semplici, avvolgere tutti gli argomenti del percorso con parentesi graffe:
.. Http: metodo :: GET / api / foo / bar / {id} / {slug}
& Nbsp;: arg id: id An
& Nbsp;: arg slug: Una lumaca
& Nbsp; elenco dei foobars corrispondenti dato id Recupera.
Parametri della stringa di query sono supportate anche:
.. Http:? Metodo :: GET / api / foo / bar / id
& Nbsp;: param id: id An
& Nbsp; Ricerca di un elenco di foobars corrispondenti dato id.
Questo è molto rudimentale e codice sperimentale al momento.

Installazione
Eseguire pip installare sfinge-http-dominio.
Quindi, aggiungere sphinx_http_domain al conf.py:
extensions = ['sphinx_http_domain']

Requisiti

• Python
• Sfinge