sphinx-contrib / redoc

ReDoc powered OpenAPI (fka Swagger) spec renderer for Sphinx.
https://sphinxcontrib-redoc.readthedocs.io/
BSD 2-Clause "Simplified" License
33 stars 20 forks source link

Error in docs #37

Open fish-train opened 3 years ago

fish-train commented 3 years ago

Example from https://sphinxcontrib-redoc.readthedocs.io/en/stable/:

redoc = [ { 'name': 'Batcomputer API', 'page': 'api', 'spec': 'specs/batcomputer.yml', 'embed': True, }, { 'name': 'Example API', 'page': 'example/index', 'spec': 'http://example.com/openapi.yml', 'opts': { 'lazy': False, 'nowarnings': False, 'nohostname': False, 'required-props-first': True, 'expand-responses': ["200", "201"], } }, ]

ReDoc doesn't have options "lazy", but it has "lazy-rendering". Another opts is written with error too.