sphinx-swagger-doc
==================
|Beerpay| |Beerpay| |GitHub stars|
Sphinx extension for documenting Swagger 2.0 APIs
Please ★ this repo if you found it useful ★ ★ ★
Features
--------
- Swagger 2.0 spec
- Generate sphinx doc
Installation
------------
.. code:: sh
pip install sphinx-swagger-doc
Dependencies
------------
- `Python <https://www.python.org>`__
- `Sphinx <http://www.sphinx-doc.org>`__
Usage
-----
`Contribute <https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CONTRIBUTING.md>`__
usage docs
Support
-------
Submit an
`issue <https://github.com/jamrizzi/sphinx-swagger-doc/issues/new>`__
Screenshots
-----------
`Contribute <https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CONTRIBUTING.md>`__
a screenshot
Contributing
------------
Review the `guidelines for
contributing <https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CONTRIBUTING.md>`__
License
-------
`MIT
License <https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/LICENSE>`__
`Jam Risser <https://jamrizzi.com>`__ © 2018
Changelog
---------
Review the
`changelog <https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CHANGELOG.md>`__
Credits
-------
- `Jam Risser <https://jamrizzi.com>`__ - Author
Support on Beerpay (actually, I drink coffee)
---------------------------------------------
A ridiculous amount of coffee :coffee: :coffee: :coffee: was consumed in
the process of building this project.
`Add some fuel <https://beerpay.io/jamrizzi/sphinx-swagger-doc>`__ if
you’d like to keep me going!
|Beerpay| |Beerpay|
.. |Beerpay| image:: https://beerpay.io/jamrizzi/sphinx-swagger-doc/badge.svg?style=beer-square
:target: https://beerpay.io/jamrizzi/sphinx-swagger-doc
.. |Beerpay| image:: https://beerpay.io/jamrizzi/sphinx-swagger-doc/make-wish.svg?style=flat-square
:target: https://beerpay.io/jamrizzi/sphinx-swagger-doc?focus=wish
.. |GitHub stars| image:: https://img.shields.io/github/stars/jamrizzi/sphinx-swagger-doc.svg?style=social&label=Stars
:target: https://github.com/jamrizzi/sphinx-swagger-doc
.. |Beerpay| image:: https://beerpay.io/jamrizzi/sphinx-swagger-doc/badge.svg?style=beer-square
:target: https://beerpay.io/jamrizzi/sphinx-swagger-doc
.. |Beerpay| image:: https://beerpay.io/jamrizzi/sphinx-swagger-doc/make-wish.svg?style=flat-square
:target: https://beerpay.io/jamrizzi/sphinx-swagger-doc?focus=wish
==================
|Beerpay| |Beerpay| |GitHub stars|
Sphinx extension for documenting Swagger 2.0 APIs
Please ★ this repo if you found it useful ★ ★ ★
Features
--------
- Swagger 2.0 spec
- Generate sphinx doc
Installation
------------
.. code:: sh
pip install sphinx-swagger-doc
Dependencies
------------
- `Python <https://www.python.org>`__
- `Sphinx <http://www.sphinx-doc.org>`__
Usage
-----
`Contribute <https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CONTRIBUTING.md>`__
usage docs
Support
-------
Submit an
`issue <https://github.com/jamrizzi/sphinx-swagger-doc/issues/new>`__
Screenshots
-----------
`Contribute <https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CONTRIBUTING.md>`__
a screenshot
Contributing
------------
Review the `guidelines for
contributing <https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CONTRIBUTING.md>`__
License
-------
`MIT
License <https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/LICENSE>`__
`Jam Risser <https://jamrizzi.com>`__ © 2018
Changelog
---------
Review the
`changelog <https://github.com/jamrizzi/sphinx-swagger-doc/blob/master/CHANGELOG.md>`__
Credits
-------
- `Jam Risser <https://jamrizzi.com>`__ - Author
Support on Beerpay (actually, I drink coffee)
---------------------------------------------
A ridiculous amount of coffee :coffee: :coffee: :coffee: was consumed in
the process of building this project.
`Add some fuel <https://beerpay.io/jamrizzi/sphinx-swagger-doc>`__ if
you’d like to keep me going!
|Beerpay| |Beerpay|
.. |Beerpay| image:: https://beerpay.io/jamrizzi/sphinx-swagger-doc/badge.svg?style=beer-square
:target: https://beerpay.io/jamrizzi/sphinx-swagger-doc
.. |Beerpay| image:: https://beerpay.io/jamrizzi/sphinx-swagger-doc/make-wish.svg?style=flat-square
:target: https://beerpay.io/jamrizzi/sphinx-swagger-doc?focus=wish
.. |GitHub stars| image:: https://img.shields.io/github/stars/jamrizzi/sphinx-swagger-doc.svg?style=social&label=Stars
:target: https://github.com/jamrizzi/sphinx-swagger-doc
.. |Beerpay| image:: https://beerpay.io/jamrizzi/sphinx-swagger-doc/badge.svg?style=beer-square
:target: https://beerpay.io/jamrizzi/sphinx-swagger-doc
.. |Beerpay| image:: https://beerpay.io/jamrizzi/sphinx-swagger-doc/make-wish.svg?style=flat-square
:target: https://beerpay.io/jamrizzi/sphinx-swagger-doc?focus=wish
1 maintainer
Metadata
1 maintainer
Release files for sphinx-swagger-doc 0.2.2
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 | |
|---|---|---|---|---|
| sphinx-swagger-doc-0.2.2.tar.gz | 5.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_swagger_doc-0.2.2-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 12.1 kB
Release files / sphinx-swagger-doc-0.2.2.tar.gz
| Download URL | sphinx-swagger-doc-0.2.2.tar.gz |
|---|---|
| Size | 5.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b440e6493e32856e52adc2b7f75b5b4b79950632f9dd2f06c313e493672f2f51
|
|
BLAKE2b-256 checksum How to use checksums |
1c8e0ad30b12c6cba59fc7f83b54e4954ba7645976a80c02b01f86027f774ef6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / sphinx_swagger_doc-0.2.2-py2.py3-none-any.whl
| Download URL | sphinx_swagger_doc-0.2.2-py2.py3-none-any.whl |
|---|---|
| Size | 6.5 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
8247a6ea4e29b01bb4193979be6533278730ecf7d014c5e0d46ad8153aa12d79
|
|
BLAKE2b-256 checksum How to use checksums |
6536aef5ec96b063ab2601c14da653e7db7065476240cc9a2ced5e1f45776a09
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinx-swagger-doc 0.2.2
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.
