From 89231a4fcd3cf469527ead5fc282aab13798032c Mon Sep 17 00:00:00 2001 From: igo95862 Date: Fri, 23 Apr 2021 13:23:45 +0300 Subject: [PATCH] docs: Document how to switch to new renderer --- docs/index.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 5f60b6f..d53974c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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