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

Requirements

  • python >= 3.3

Installation

This package can be installed using pip:

pip install sphinxcontrib-swaggersphinx

Usage

Include this an extension in your Sphinx conf.py:

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 Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page