sphinx-http-domain adalah plugin Sphinx untuk menambahkan domain HTTP, sehingga dokumentasi metode HTTP tenang.
Anda dapat dokumen metode sederhana, bungkus argumen di jalur dengan keriting-kawat gigi:
.. Http: Metode :: GET / api / foo / bar / {id} / {slug}
& Nbsp;: arg id: Sebuah id
& Nbsp;: arg slug: A slug
& Nbsp; Ambil daftar Foobars cocok diberikan id.
Parameter string kueri juga didukung:
.. Http:? Metode :: GET / api / foo / bar / id
& Nbsp;: param id: Sebuah id
& Nbsp; Cari daftar Foobars cocok diberikan id.
Hal ini sangat sederhana dan kode eksperimental pada saat ini.
Instalasi
Jalankan pip install sphinx-http-domain.
Kemudian, tambahkan sphinx_http_domain ke conf.py Anda:
ekstensi = ['sphinx_http_domain']
Persyaratan :
- Python
- Sphinx
Komentar tidak ditemukan