sphinx-http-domain

sfinga-http-doména je Sphinx plugin přidat doménu HTTP, což umožňuje dokumentaci REST metod HTTP.
Můžete zdokumentovat jednoduchých metod, zabalte žádné argumenty v cestě s složených závorek-:
.. Http: Metoda :: GET / API / foo / bar / {id} / {} slimák
& Nbsp;: arg id: id
& Nbsp;: arg Slug: slimák
& Nbsp; Načíst seznam foobars odpovídající daným ID.
Podporovány jsou také parametry řetězec dotazu:
.. Http:? Metoda :: GET / API / foo / bar / id
& Nbsp;: param id: id
& Nbsp; Hledat Seznam foobars odpovídající daným ID.
To je velmi primitivní a experimentální kód v tuto chvíli.

Instalace
Spusťte pip nainstalovat sfinga-http-domény.
Poté přidejte sphinx_http_domain do vašeho conf.py:
extensions = ['sphinx_http_domain']

Požadavky na :

• Python
• Sphinx