Skip to content

collective/sphinxcontrib-httpexample

Repository files navigation

sphinxcontrib-httpexample

https://github.com/collective/sphinxcontrib-httpexample/actions/workflows/build.yml/badge.svg?branch=master https://coveralls.io/repos/github/collective/sphinxcontrib-httpexample/badge.svg?branch=master 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 next to sphincontrib-httpdomain as follows:

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

License

The project is licensed under the GPLv2.