sphinx-http-domain ist eine Sphinx-Plugin, um eine HTTP-Domäne hinzufügen, so dass die Dokumentation von RESTful HTTP-Methoden.
Sie können einfache Methoden zu dokumentieren, wickeln alle Argumente in der Bahn mit dem lockigen Streben:
.. Http: Verfahren :: GET / api / foo / bar / {id} / {} slug
& Nbsp;: arg-ID: eine ID-
& Nbsp;: arg Slug: Eine Schnecke
& Nbsp; Abrufen Liste der passenden foobars angegebenen ID.
Query-String-Parameter werden ebenfalls unterstützt:
.. Http:? Method :: GET / api / foo / bar / id
& Nbsp;: param-ID: eine ID-
& Nbsp; Suche nach einer Liste von passenden foobars angegebenen ID.
Das ist sehr rudimentär und experimentelle Code im Moment.
Installation
Führen pip installieren sphinx-http-Domäne.
Dann fügen Sie sphinx_http_domain um Ihre conf.py:
Erweiterungen = ['sphinx_http_domain']
Anforderungen :
- Python
- Sphinx
Kommentare nicht gefunden