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
Allow :context: directive to take 'reset' option. Fixes #2892. #2913
Allow :context: directive to take 'reset' option. Fixes #2892. #2913
Conversation
@mdboom - is a CHANGELOG entry needed? |
As a new feature, I would mention this briefly in whatsnew. |
Yes, and definitely api_changes.rst and maybe a whats_new.rst |
@mdboom @tacaswell - Does this go in the Also, is |
I don't think we need an api changes entry -- that's really only for backward-incompatible things. I would put it in a new section in what's new called "Sphinx extensions" (which we don't normally have, because it doesn't change much). I don't think context True and False need to work. The old docs saying "bool" essentially means "present or not". |
@mdboom - done - is this ok? |
@mdboom interesting. I apparently miss-understood that. |
@mdboom @tacaswell - the Travis error is unrelated. |
@mdboom @tacaswell - does this look good to go? |
@astrofrog This needs a rebase. I suspect from conflicts from your other PR |
@tacaswell - thanks for letting me know - I've now rebased this |
Allow :context: directive to take 'reset' option. Fixes #2892.
@tacaswell - thanks for merging this! |
This allows:
and resets the plotting context. This is crucial when if one wants to use
:context:
for multiple figures in documentation. See #2892.One question - should:
and
work? If so, I'll need to slightly adjust
_option_context
.cc @mdboom