Sphinx extension for documenting Swagger 2.0 APIs
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx-swagger-doc-0.2.2.tar.gz
.
File metadata
- Download URL: sphinx-swagger-doc-0.2.2.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b440e6493e32856e52adc2b7f75b5b4b79950632f9dd2f06c313e493672f2f51 |
|
MD5 | 7fb733aa0f79bc71d2d4826c11a1718d |
|
BLAKE2b-256 | 1c8e0ad30b12c6cba59fc7f83b54e4954ba7645976a80c02b01f86027f774ef6 |
File details
Details for the file sphinx_swagger_doc-0.2.2-py2.py3-none-any.whl
.
File metadata
- Download URL: sphinx_swagger_doc-0.2.2-py2.py3-none-any.whl
- Upload date:
- Size: 6.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8247a6ea4e29b01bb4193979be6533278730ecf7d014c5e0d46ad8153aa12d79 |
|
MD5 | 3d2f7b07b127e69b697742e3d9b1397c |
|
BLAKE2b-256 | 6536aef5ec96b063ab2601c14da653e7db7065476240cc9a2ced5e1f45776a09 |