Skip to content

Commit

Permalink
Add notice about sphinxcontrib-redoc
Browse files Browse the repository at this point in the history
sphinxcontrib-redoc is another project that is focused on rendering
OpenAPI spec separately from Sphinx pages, i.e. on separate three-panel
page powered by ReDoc.
  • Loading branch information
ikalnytskyi committed Apr 9, 2017
1 parent 20a03ba commit df22193
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
sphinxcontrib-openapi
=====================

.. hint::

Check out `sphinxcontrib-redoc`_ if you are interested in separate
three-panel OpenAPI spec rendering.

**sphinxcontrib-openapi** is a `Sphinx`_ extension to generate APIs docs from
`OpenAPI`_ (fka Swagger) spec. It depends on `sphinxcontrib-httpdomain`_ that
provides an HTTP domain for describing RESTful HTTP APIs, so we don't need to
Expand Down Expand Up @@ -59,3 +64,4 @@ paths
.. _Sphinx: https://sphinx.pocoo.org
.. _OpenAPI: https://openapis.org/specification
.. _sphinxcontrib-httpdomain: https://pythonhosted.org/sphinxcontrib-httpdomain/
.. _sphinxcontrib-redoc: https://sphinxcontrib-redoc.readthedocs.io/

0 comments on commit df22193

Please sign in to comment.