sphinx-http-domain

sfinksen-http-domenet er en Sphinx plugin for å legge en HTTP-domene, slik at dokumentasjon av RESTful HTTP metoder.
Du kan dokumentere enkle metoder, pakk noen argumenter i banen med krøllete-seler:
.. Http: metode :: GET / api / foo / bar / {id} / {slug}
& Nbsp;: arg id: En id
& Nbsp;: arg slug: En slug
& Nbsp; Hente liste over foobars matching gitt id.
Søkestrengparametere støttes også:
.. Http: metode :: GET / api / foo / bar / id
& Nbsp;: param id: En id
& Nbsp; Søk etter en liste over foobars matching gitt id.
Dette er veldig rudimentær og eksperimentell kode i øyeblikket.

Installasjon
Kjør pip installere sfinksen-http-domenet.
Deretter legger sphinx_http_domain til conf.py:
extensions = ['sphinx_http_domain']

Krav

• Python
• Sphinx