.. image:: https://github.com/collective/sphinxcontrib-httpexample/actions/workflows/build.yml/badge.svg?branch=master :target: https://github.com/collective/sphinxcontrib-httpexample/actions
.. image:: https://coveralls.io/repos/github/collective/sphinxcontrib-httpexample/badge.svg?branch=master :target: https://coveralls.io/github/collective/sphinxcontrib-httpexample?branch=master
.. image:: https://badge.fury.io/py/sphinxcontrib-httpexample.svg :target: https://badge.fury.io/py/sphinxcontrib-httpexample
.. image:: https://readthedocs.org/projects/sphinxcontrib-httpexample/badge/?version=latest :target: http://sphinxcontrib-httpexample.readthedocs.io/en/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_.
.. _sphinxcontrib-httpdomain: https://pythonhosted.org/sphinxcontrib-httpdomain/ .. _plone.restapi: http://plonerestapi.readthedocs.org/
Directive for generating various RESTful HTTP API call examples from single HTTP request.
Supported tools:
.. _curl: https://curl.haxx.se/ .. _wget: https://www.gnu.org/software/wget/ .. _httpie: https://httpie.org/ .. _python-requests: http://docs.python-requests.org/
This extension has been used at least in the following documentations:
Full documentation for end users can be found in the "docs" folder. It is also available online at http://sphinxcontrib-httpexample.readthedocs.org/
Add sphinxcontrib-httpexample into requirements of your product documentation and into the configuration file of your Sphinx documentation next to sphincontrib-httpdomain as follows:
.. code:: python
extensions = ['sphinxcontrib.httpdomain', 'sphinxcontrib.httpexample']The project is licensed under the GPLv2.