Render HTTP docs in page

[sindrehan]

This way

instead of this way

Some considerations:

• The example code snippets are an extension of the OpenAPI protocol and aren't supported by the swagger-ui plugin
• Bundling the docs for offline use does not appear to work when doing it this way
• The render_swagger plugin supports output from redoc, but it's even more obvious that it's just an iframe with external content. Here's an example.

[codecov]

Codecov Report

Patch and project coverage have no change.

Comparison is base (bc26855) 73.17% compared to head (ef54904) 73.17%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #152   +/-   ##
=======================================
  Coverage   73.17%   73.17%           
=======================================
  Files          11       11           
  Lines        1178     1178           
=======================================
  Hits          862      862           
  Misses        316      316           

Flag	Coverage Δ
macos-latest_3.10	73.17% <ø> (ø)
macos-latest_3.11	73.17% <ø> (ø)
macos-latest_3.8	73.15% <ø> (ø)
macos-latest_3.9	73.15% <ø> (ø)
ubuntu-latest_3.10	73.17% <ø> (ø)
ubuntu-latest_3.11	73.17% <ø> (ø)
ubuntu-latest_3.8	73.15% <ø> (ø)
ubuntu-latest_3.9	73.15% <ø> (ø)
windows-latest_3.10	73.15% <ø> (ø)
windows-latest_3.11	73.15% <ø> (?)
windows-latest_3.8	73.12% <ø> (ø)
windows-latest_3.9	73.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sindrehan]

Figured out how to use the render_swagger plugin to show the output from redoc

Doesn't work very well with dark mode though

Pretty sure that's fixable with some css/js magic.

Here's an example of a dark mode for redoc, redark