Metadata-Version: 2.4
Name: sphinxcontrib-httpexample
Version: 2.0rc1
Summary: Adds example directive for sphinx-contrib httpdomain
Project-URL: Repository, https://github.com/collective/sphinxcontrib-httpexample
Author-email: Asko Soukka <asko.soukka@iki.fi>
License: GPL-2.0-only
Keywords: documentation,extension,http,rest,sphinx
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Requires-Dist: docutils
Requires-Dist: importlib-metadata
Requires-Dist: importlib-resources
Requires-Dist: sphinx
Requires-Dist: sphinxcontrib-httpdomain
Provides-Extra: sphinx747
Requires-Dist: sphinx==7.4.7; (python_version >= '3.9') and extra == 'sphinx747'
Provides-Extra: sphinx802
Requires-Dist: sphinx==8.0.2; (python_version >= '3.10') and extra == 'sphinx802'
Provides-Extra: sphinx813
Requires-Dist: babel; extra == 'sphinx813'
Requires-Dist: sphinx==8.1.3; (python_version >= '3.10') and extra == 'sphinx813'
Provides-Extra: sphinx823
Requires-Dist: sphinx==8.2.3; (python_version >= '3.11') and extra == 'sphinx823'
Provides-Extra: test
Description-Content-Type: text/markdown

sphinxcontrib-httpexample
=========================

.. 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/


Features
--------

* Directive for generating various RESTful HTTP API call examples from single HTTP request.

* Supported tools:

  - curl_
  - wget_
  - httpie_
  - python-requests_

.. _curl: https://curl.haxx.se/
.. _wget: https://www.gnu.org/software/wget/
.. _httpie: https://httpie.org/
.. _python-requests: http://docs.python-requests.org/


Examples
--------

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

* http://plonerestapi.readthedocs.org/
* http://sphinxcontrib-httpexample.readthedocs.org/
* https://guillotina.readthedocs.io/en/latest/


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:

..  code:: python

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


License
-------

The project is licensed under the GPLv2.
