sphinx-http-domain

σφίγγα-http-τομέα είναι ένα Σφίγγα plugin για να προσθέσετε ένα πεδίο HTTP, επιτρέποντας την τεκμηρίωση των ξεκούραστη μεθόδων HTTP.
Μπορείτε να τεκμηριώσετε απλές μεθόδους, τυλίξτε επιχειρήματα στη διαδρομή σε αγκύλες:
.. Http: μέθοδος :: GET / api / foo / bar / {id} / {γυμνοσάλιαγκας}
& Nbsp?: Arg id: ένα αναγνωριστικό
& Nbsp?: Arg γυμνοσάλιαγκα: Ένας γυμνοσάλιαγκας
& Nbsp? Κατάλογος των foobars ταιριάζουν το id Ανάκτηση.
Παραμέτρους συμβολοσειράς ερωτήματος Υποστηρίζονται επίσης:
.. Http: μέθοδος :: GET / api / foo / bar / id
& Nbsp?: Id param: ένα αναγνωριστικό
& Nbsp? Αναζήτησης για έναν κατάλογο των foobars ταιριάζουν το id.
Αυτό είναι πολύ στοιχειώδης και πειραματική κωδικό τη στιγμή.

Εγκατάσταση
Εκτελέστε pip εγκαταστήσετε σφίγγα-http-τομέα.
Στη συνέχεια, προσθέστε sphinx_http_domain να conf.py σας:
επεκτάσεις = ['sphinx_http_domain']

Απαιτήσεις :

• Python
• Σφίγγα