Skip to main content

Sphinx extension for documenting Swagger 2.0 APIs

pip install sphinxcontrib-swaggerdoc

Usage

Include extension in conf.py

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:: http://petstore.swagger.io/v2/swagger.json

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:: http://petstore.swagger.io/v2/swagger.json
   pet
   store

Note

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

.. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/pet
.. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/user
.. swaggerdoc:: http://petstore.swagger.wordnik.com/api/api-docs/store

Metadata

Release files for sphinxcontrib-swaggerdoc 0.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for sphinxcontrib-swaggerdoc 0.1.7
File Interpreter ABI Platform Actions
sphinxcontrib_swaggerdoc-0.1.7-py2.py3-none-any.whl Python 3, Python 2 none any Details for sphinxcontrib_swaggerdoc-0.1.7-py2.py3-none-any.whl

Release files / sphinxcontrib_swaggerdoc-0.1.7-py2.py3-none-any.whl

Download URL sphinxcontrib_swaggerdoc-0.1.7-py2.py3-none-any.whl
Size 7.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
3ee69c6d53ee216405fa201cbd2ae47dd71aeef2a63ddcae595081c2459c2498
BLAKE2b-256 checksum
How to use checksums
30129a2d31c9369ef1b1a14d7f47ce8fcfa4fe62aa1c4e9cf259915dfb7f1a4d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for sphinxcontrib-swaggerdoc 0.1.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page