Skip to main content

Sphinx extension for documenting Swagger 2.0 APIs

Project description

Sphinx extension for documenting Swagger 2.0 APIs

pip install sphinxcontrib-swaggerdoc


Include extension in

extensions = ['sphinxcontrib.swaggerdoc']

Add directive pointing to a remote Swagger api-docs

.. swaggerv2doc:: URL/swagger.json

or to a local file

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

For example

.. swaggerv2doc::

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.

.. swaggerv2doc::


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

.. swaggerdoc::
.. swaggerdoc::
.. swaggerdoc::

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page