https://github.com/sphinx-contrib/redoc

ReDoc powered OpenAPI (fka Swagger) spec renderer for Sphinx.
https://github.com/sphinx-contrib/redoc

Last synced: 7 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/sphinx-contrib/redoc
• Owner: sphinx-contrib
• License: bsd-2-clause
• Created: 2017-04-05T19:58:58.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-08T10:17:26.000Z (over 1 year ago)
• Last Synced: 2025-05-02T03:46:11.188Z (8 days ago)
• Language: Python
• Homepage: https://sphinxcontrib-redoc.readthedocs.io/
• Size: 917 KB
• Stars: 35
• Watchers: 5
• Forks: 20
• Open Issues: 20
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
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