sphinx-http-domain

sfinksi-http-domain on Sfinksi plugin lisätä HTTP toimialueen, jolloin dokumentointi RESTful HTTP menetelmiä.
Voit dokumentoida yksinkertaisia ​​menetelmiä, kääri mitään perusteluja tiellä kihara-henkselit:
.. Http: menetelmä :: GET / api / foo / bar / {id} / {etana}
& Nbsp;: arg id: id
& Nbsp;: arg Slug: etana
& Nbsp; noutaminen luettelo foobars vastaavia annettu id.
Kyselymerkkijonon parametrit ovat tuettuja:
.. Http: menetelmä :: GET / api / foo / bar /? Id
& Nbsp;: param id: id
& Nbsp; Etsi listan foobars vastaavia annettu id.
Tämä on hyvin alkeellinen ja kokeellinen koodin tällä hetkellä.

Asennus
Suorita pip asentaminen sfinksi-http-domain.
Lisää sitten sphinx_http_domain teidän conf.py:
laajennukset = ['sphinx_http_domain "]

vaatimukset

• Python
• sfinksi