Adds example directive for sphinx-contrib httpdomain
Project description
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:
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 next to sphincontrib-httpdomain as follows:
extensions = ['sphinxcontrib.httpdomain', 'sphinxcontrib.httpexample']License
The project is licensed under the GPLv2.
Changelog
0.6.0 (2017-05-11)
Support non-json requests [jaroel]
Support application/json; charset=utf-8 [skyzyx]
0.5.2 (2017-03-09)
Fix packaging to include the files in static #3 [csenger]
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]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-httpexample-0.6.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | baaf0c6365da871a29c5dc895ae55301a1323b8dec123c00f2e903257c93c229 |
|
| MD5 | 3855aa175ff43fe97a31fcd1eb75d38f |
|
| BLAKE2b-256 | 9fd9e8fb50f99ab50d6f3999b2c2fd303439cba51b3ac66ccc465dd4c3906574 |
Hashes for sphinxcontrib_httpexample-0.6.0-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 52659e7ce8e951a236a28646f2e85668f776057da41040313678d0fbae0c4d2b |
|
| MD5 | 225b0da1f7bc27e13b9b9e0b9291248a |
|
| BLAKE2b-256 | 195521b21e344209d7934c941b25e932a44c366afd7db2c8986cadab3d7c8c86 |
