redoc

redoc copied to clipboard

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':...

fish-train

Ordering of endpoints is random with the use of yaml library : switch to oyaml

1

If you want an embedded openapi in the page, the order of the endpoints is not kept. The issue stem from there : https://github.com/sphinx-contrib/redoc/blob/master/sphinxcontrib/redoc.py#L94 The yaml library does not keep...

rompom

Fails to build some targets

1

Apparently, sphinx-build fails to build some targets (e.g. text, latexpdf, XML) with this extension included. An IOError Exception is thrown. > IOError: [Errno 2] No such file or directory: u'/mnt/g/git/api-docs/build/text/_static/redoc.js'...

DavidZeise

Can't use relative URL to spec.yaml file

4

I'm trying to use a relative URL to the spec.yaml file, which fails because it's interpreted as a file path: ```python-traceback Traceback (most recent call last): File "/usr/lib/python3.6/site-packages/sphinx/cmdline.py", line 304,...

sn4kebite

pkg_resources is deprecated and should be replaced with alternatives like packaging, importlib.metadata and importlib.resources

kasium

I can't seem to find a way to inject CSS without manually editing the build output file - any graceful way to do this?

dylanh724

`template` feels a bit mysterious - mind updating the README? What _is_ the default template? I can't even seem to find it in src. Is this a path/to/_templates/some-jinja2-template .html kind...

dylanh724

Starting with Sphinx 8, use of sphinxcontrib-redoc produces the following warning for any build after the first: ``` WARNING: Aborted attempted copy from /home/eagle/lsst/gafaelfawr/.tox/docs/lib/python3.12/site-packages/sphinxcontrib/redoc.js to /home/eagle/lsst/gafaelfawr/docs/_build/html/_static/redoc.js (the destination path has...

rra