Skip to main content

Convert swagger JSON files to tables in Sphinx

Project description

A Sphinx extension for documenting Swagger APIs.

pip install sphinxcontrib-swaggersphinx


  • python >= 3.3


This package can be installed using pip:

pip install sphinxcontrib-swaggersphinx


Include this an extension in your Sphinx

extensions = ['sphinxcontrib.swaggersphinx']

Then you can use it in your .rst files to include Swagger documentation:

.. swaggersphinx:: /path/to/swagger.json

You can include local files (relative to the .rst), local files (full path), or URLs:

.. swaggersphinx:: /full/path/swagger.json

.. swaggersphinx:: relative/swagger.json

.. swaggersphinx:: http://localhost/api/swagger.json

Project details

Download files

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

Source Distribution

sphinxcontrib-swaggersphinx-0.1.0.tar.gz (3.5 kB view hashes)

Uploaded source

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