Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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


Release history Release notifications

Download files

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

Files for sphinxcontrib-swaggersphinx, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_swaggersphinx-0.1.0-py3-none-any.whl (5.4 kB) File type Wheel Python version 3.6 Upload date Hashes View hashes
Filename, size sphinxcontrib-swaggersphinx-0.1.0.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page