sphinx-http-domain 0.2

Sphinx domain to mark up RESTful web services in ReST
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, 14:21 GMT
price:
FREE!
developed by:
David Zentgraf
homepage:
github.com
license type:
BSD License 
category:
ROOT \ Documentation

FREE!

In a hurry? Add it to your Download Basket!

user rating

UNRATED
0.0/5
 

0/5

Rate it!

Add your review!

SUBMIT