sfinx-http-domänen är en Sphinx plugin för att lägga till en HTTP-domän, vilket gör att dokumentation av RESTful HTTP-metoderna.
Du kan dokumentera enkla metoder, linda några argument i vägen med krullparenteser:
.. Http: metod :: GET / api / foo / bar / {id} / {snigel}
& Nbsp;: arg id: En id
& Nbsp;: arg slug: En snigel
& Nbsp; Hämta lista över foobars matcha givet id.
Frågesträngparametrar stöds också:
.. Http: metod :: GET / api / foo / bar / id
& Nbsp;: param id: En id
& Nbsp; Sök efter en lista över foobars matcha givet id.
Detta är mycket besvärligt och experimentell kod just nu.
Installation
Kör PIP installera sfinx-http-domänen.
Lägg sedan till sphinx_http_domain till conf.py:
förlängningar = ['sphinx_http_domain']
Krav :
- Python
- Sphinx
Kommentarer hittades inte