Metadata-Version: 2.0
Name: sphinxcontrib-swaggerdoc
Version: 0.1.7
Summary: Sphinx extension for documenting Swagger 2.0 APIs
Home-page: https://github.com/unaguil/sphinx-swaggerdoc
Author: Unai Aguilera
Author-email: unai.aguilera@deusto.es
License: MIT
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Dist: sphinx
Requires-Dist: requests
Requires-Dist: requests-file
Requires-Dist: future

========================
sphinxcontrib-swaggerdoc
========================

Sphinx extension for documenting Swagger 2.0 APIs

.. code:: bash

   pip install sphinxcontrib-swaggerdoc

Usage
=====

Include extension in ``conf.py``

.. code:: python

   extensions = ['sphinxcontrib.swaggerdoc']

Add directive pointing to a remote Swagger api-docs

.. code:: restructuredtext

    .. swaggerv2doc:: URL/swagger.json

or to a local file

.. code:: restructuredtext

    .. swaggerv2doc:: file:///PATH/swagger.json

For example

.. code:: restructuredtext

    .. swaggerv2doc:: http://petstore.swagger.io/v2/swagger.json

If the Swagger description contains multiple tags, you can select a subset
for the documentation generation. For example, the following directive only
generates the documentation for the methods contained in tags **pet** and
**store**.

.. code:: restructuredtext

    .. swaggerv2doc:: http://petstore.swagger.io/v2/swagger.json
       pet
       store

Note
====

The old directive for Swagger 1.0 is still usable. For example,

.. code:: restructuredtext

    .. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/pet
    .. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/user
    .. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/store


