Skip to content
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.

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

Propagate ReDoc options from Sphinx's conf.py #4

Closed
ikalnytskyi opened this issue Apr 12, 2017 · 0 comments
Closed

Propagate ReDoc options from Sphinx's conf.py #4

ikalnytskyi opened this issue Apr 12, 2017 · 0 comments
Assignees

Comments

@ikalnytskyi
Copy link
Member

So far ReDoc has the following options:

  • lazy-rendering
  • suppress-warnings
  • hide-hostname
  • required-props-first
  • expand-responses

It would be nice to have a way to propagate them from Sphinx's conf.py to ReDoc page as one may be eager to have them in some cases.

@ikalnytskyi ikalnytskyi self-assigned this Apr 12, 2017
ikalnytskyi added a commit that referenced this issue Apr 12, 2017
So far `sphinxcontrib-redoc` didn't support any of ReDoc options and
fully relied on defaults. That's inconvenient in one cases and limits
users in another. In order to overcome this inconvenience, this patch
adds a new `redoc['opts']` setting node with ReDoc options. Here's
what it supports:

 * `lazy-rendering`
 * `suppress-warnings`
 * `hide-hostname`
 * `required-props-first`
 * `expand-responses`

Fixes #4
ikalnytskyi added a commit that referenced this issue Apr 12, 2017
So far `sphinxcontrib-redoc` didn't support any of ReDoc options and
fully relied on defaults. That's inconvenient in one cases and limits
users in another. In order to overcome this inconvenience, this patch
adds a new `redoc['opts']` setting node with ReDoc options. Here's
what it supports:

 * `lazy-rendering`
 * `suppress-warnings`
 * `hide-hostname`
 * `required-props-first`
 * `expand-responses`

Fixes #4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant