Metadata-Version: 1.1
Name: sphinxcontrib-httpexample
Version: 0.6.1
Summary: Adds example directive for sphinx-contrib httpdomain
Home-page: https://github.com/collective/sphinxcontrib-httpexample
Author: Asko Soukka
Author-email: asko.soukka@iki.fi
License: GPL version 2
Description: sphinxcontrib-httpexample
        =========================
        
        .. image:: https://secure.travis-ci.org/collective/sphinxcontrib-httpexample.png
           :target: http://travis-ci.org/collective/sphinxcontrib-httpexample
        
        .. 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/
        
        
        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.
        
        Changelog
        =========
        
        0.6.1 (2017-05-11)
        ------------------
        
        - Release as universal wheel
          [datakurre]
        
        
        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]
        
Keywords: sphinx,extension,http,rest,documentation
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
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 :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
