redoc icon indicating copy to clipboard operation
redoc copied to clipboard

ReDoc powered OpenAPI (fka Swagger) spec renderer for Sphinx.

sphinxcontrib-redoc

|pypi-version| |travis-ci|

The Sphinx_ extension that renders OpenAPI_ (fka Swagger) specs with love (❤️) using amazing ReDoc_. Don't believe it? Here's the proof_. Now stop frustrating and start moving your projects to OpenAPI and ReDoc with this small first step:

.. code:: bash

$ pip install sphinxcontrib-redoc
  • Free software: BSD License
  • Documentation: https://sphinxcontrib-redoc.readthedocs.io
  • Source: https://github.com/ikalnytskyi/sphinxcontrib-redoc
  • Bugs: https://github.com/ikalnytskyi/sphinxcontrib-redoc/issues

Any feedback, any contribution is really appreciated!

.. _Sphinx: https://www.sphinx-doc.org/ .. _OpenAPI: https://openapis.org/specification .. _ReDoc: https://github.com/Rebilly/ReDoc .. _the proof: https://sphinxcontrib-redoc.readthedocs.io/en/latest/api/github/

.. |pypi-version| image:: https://img.shields.io/pypi/v/sphinxcontrib-redoc.svg :target: https://pypi.python.org/pypi/sphinxcontrib-redoc

.. |travis-ci| image:: https://img.shields.io/travis/ikalnytskyi/sphinxcontrib-redoc.svg :target: https://travis-ci.org/ikalnytskyi/sphinxcontrib-redoc