sphinxcontrib-swaggersphinx

Convert swagger JSON files to tables in Sphinx

These details have not been verified by PyPI

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Project description

A Sphinx extension for documenting Swagger APIs.

pip install sphinxcontrib-swaggersphinx

This package can be installed using pip:

pip install sphinxcontrib-swaggersphinx

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

These details have not been verified by PyPI

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

This version

0.1.0

Jul 25, 2017

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

Uploaded Jul 25, 2017 Source

Uploaded Jul 25, 2017 Python 3

Hashes for sphinxcontrib-swaggersphinx-0.1.0.tar.gz
Algorithm	Hash digest
SHA256	`c70c3608e5a9dd0a8c0fbac95007754e65c2fbf53ba06499c70f258c2e0d09a1`
MD5	`34f00a57502e212e9326047753dc9278`
BLAKE2b-256	`1dea47afa83c27c024257c03b3d2b1094bb7f1ebafc5b38a1158130e7203ab98`

Hashes for sphinxcontrib_swaggersphinx-0.1.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`9443a272940514c0a53ad3b65c8ec3d3dcca9214ad0b51092ca135dbd2e6cc93`
MD5	`a7237320bb1b7ae574e144de2b3f7270`
BLAKE2b-256	`64440df696a9155290f1c37dc3ec3eed67b989760651178386a5dcb1a6b4919f`