sphinx-http-domain 0.2

Sphinx domain to mark up RESTful web services in ReST

  Add it to your Download Basket!

 Add it to your Watch List!

0/5

Rate it!
send us
an update
LICENSE TYPE:
BSD License 
USER RATING:
UNRATED
  0.0/5
DEVELOPED BY:
David Zentgraf
HOMEPAGE:
github.com
CATEGORY:
ROOT \ Documentation
sphinx-http-domain is a Sphinx plugin to add an HTTP domain, allowing the documentation of RESTful HTTP methods.

You can document simple methods, wrap any arguments in the path with curly-braces:

.. http:method:: GET /api/foo/bar/{id}/{slug}

 :arg id: An id
 :arg slug: A slug


 Retrieve list of foobars matching given id.

Query string parameters are also supported:

.. http:method:: GET /api/foo/bar/?id

 :param id: An id


 Search for a list of foobars matching given id.

This is very rudimentary and experimental code at the moment.

Installation


Run pip install sphinx-http-domain.

Then, add sphinx_http_domain to your conf.py:

extensions = ['sphinx_http_domain']

Last updated on March 14th, 2011

requirements

#HTTP domain #Sphinx plugin #Sphinx #HTTP #domain #plugin

Add your review!

SUBMIT