sphinx-http-domain

Software Screenshot:
sphinx-http-domain
Software Details:
Version: 0.2
Upload Date: 12 May 15
Developer: David Zentgraf
Distribution Type: Freeware
Downloads: 8

Rating: nan/5 (Total Votes: 0)

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']

Requirements:

  • Python
  • Sphinx

Similar Software

Comments to sphinx-http-domain

Comments not found
Add Comment
Turn on images!