A Sphinx extension for documenting Swagger APIs.
pip install sphinxcontrib-swaggersphinxRequirements
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.jsonYou 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.json1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-swaggersphinx 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| sphinxcontrib-swaggersphinx-0.1.0.tar.gz | 3.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxcontrib_swaggersphinx-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.8 kB
Release files / sphinxcontrib-swaggersphinx-0.1.0.tar.gz
| Download URL | sphinxcontrib-swaggersphinx-0.1.0.tar.gz |
|---|---|
| Size | 3.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c70c3608e5a9dd0a8c0fbac95007754e65c2fbf53ba06499c70f258c2e0d09a1
|
|
BLAKE2b-256 checksum How to use checksums |
1dea47afa83c27c024257c03b3d2b1094bb7f1ebafc5b38a1158130e7203ab98
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sphinxcontrib_swaggersphinx-0.1.0-py3-none-any.whl
| Download URL | sphinxcontrib_swaggersphinx-0.1.0-py3-none-any.whl |
|---|---|
| Size | 5.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9443a272940514c0a53ad3b65c8ec3d3dcca9214ad0b51092ca135dbd2e6cc93
|
|
BLAKE2b-256 checksum How to use checksums |
64440df696a9155290f1c37dc3ec3eed67b989760651178386a5dcb1a6b4919f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinxcontrib-swaggersphinx 0.1.0
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.
