dokai / sphinxcontrib-httpexample

Adds example directive for sphinx-contrib httpdomain

sphinxcontrib-httpexample

sphinxcontrib-httpexample enhances sphinxcontrib-httpdomain, a Sphinx domain extension for describing RESTful HTTP APIs in detail, with a simple call example directive. The new directive provided by this extension generates RESTful HTTP API call examples for different tools from a single HTTP request example.

The audience for this extension are developers and technical writes documenting their RESTful HTTP APIs. This extension has originally been developed for documenting plone.restapi.

Features

• Directive for generating various RESTful HTTP API call examples from single HTTP request.
• Supported tools:
  • curl
  • wget
  • httpie
  • python-requests

Examples

This extension has been used at least in the following documentations:

• http://plonerestapi.readthedocs.org/
• http://sphinxcontrib-httpexample.readthedocs.org/

Documentation

Full documentation for end users can be found in the "docs" folder. It is also available online at http://sphinxcontrib-httpexample.readthedocs.org/

Installation

Add sphinxcontrib-httpexample into requirements of your product documentation and into the configuration file of your Sphinx documentation next to sphincontrib-httpdomain as follows:

extensions = ['sphinxcontrib.httpdomain', 'sphinxcontrib.httpexample']

License

The project is licensed under the GPLv2.