сфинкс-HTTP-домейн е Сфинкс плъгин за добавяне на HTTP домейн, което позволява на документацията на спокоен методи HTTP.
Можете да документира прости методи, увийте никакви аргументи в пътя в скоби:
.. HTTP: метод :: GET / API / Foo / бар / {ID} / {плужек}
& Nbsp;: арг ID: документ за самоличност
& Nbsp;: арг Slug: A плужек
& Nbsp; Изтегли списък на foobars съвпадение дадена ID.
Струнни Query параметри също се поддържат:
.. HTTP:? Метод :: GET / API / Foo / бар / лична карта
& Nbsp;: Парам ID: документ за самоличност
& Nbsp; Търсене на списък на foobars съвпадение дадена ID.
Това е много елементарен и експериментално код в момента.
<Силен>
Монтаж
Стартирай PIP инсталирате сфинкс-HTTP-домейн.
След това добавете sphinx_http_domain да си conf.py:
разширения = ['sphinx_http_domain']
<силни> Изисквания
- Python
- Sphinx
Коментари не е намерена