Skip to content

docs: Document how to switch to new renderer #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Document how to switch to new renderer #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,14 @@ taking precedence over ``include`` and ``paths``)

Would render the ``head`` method, followed by the ``get`` method, followed by the rest of the methods in their declared ordered.

``openapi_default_renderer``
A string to select the renderer.

Currently has two options:

* ``httpdomain:old`` Old HTTP renderer. Well tested but lacks support for JSON schemas. Default.
* ``httpdomain`` New renderer with support for JSON schemas but not as well tested.


.. _Sphinx: https://www.sphinx-doc.org/en/master/
.. _OpenAPI: https://github.com/OAI/OpenAPI-Specification
Expand Down