Skip to main content

Adds example directive for sphinx-contrib httpdomain

Project description

sphinxcontrib-httpexample

https://secure.travis-ci.org/collective/sphinxcontrib-httpexample.png https://coveralls.io/repos/github/collective/sphinxcontrib-httpexample/badge.svg?branch=master https://badge.fury.io/py/sphinxcontrib-httpexample.svg https://readthedocs.org/projects/sphinxcontrib-httpexample/badge/?version=latest

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

Examples

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

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 with sphincontrib-httpdomain as follow:

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

License

The project is licensed under the GPLv2.

Changelog

0.5.1 (2017-03-05)

  • Update README and documentation [datakurre]

0.5.0 (2017-03-05)

  • Change development status to beta [datakurre]

0.4.2 (2017-03-05)

  • Fix issue where wget basic auth required challenge from backend, which is not always available [datakurre]

0.4.1 (2017-03-05)

  • Fix issue where generate httpie-commands did not always set Accept and Content-Type -headers [datakurre]

0.4.0 (2017-03-05)

  • Add support for wget [datakurre]

0.3.0 (2017-03-05)

  • Add generic ‘Authorization’-header support [datakurre]

0.2.1 (2017-03-05)

  • Fix issue where Authorization-header was always requires [datakurre]

  • Fix raise proper exception when parsing bad requests [datakurre]

  • Fix issue where httpie-builder did not quote values with spaces [datakurre]

  • Fix link to python-requests’ documentation [datakurre]

0.2.0 (2017-03-05)

  • Add support for GET requests [datakurre]

0.1.0 (2017-03-05)

  • First release [datakurre]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-httpexample-0.5.1.tar.gz (19.2 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page