Deprecate math_symbol_table function directive #14763
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timhoffm
approved these changes
Jul 14, 2019
QuLogic
reviewed
Jul 18, 2019
| @@ -137,16 +140,26 @@ def get_n(n, l): | |||
| return [] | |||
|
|
|||
|
|
|||
| @cbook.deprecated("3.2", alternative="MathSymbolTableDirective") | |||
There was a problem hiding this comment.
This file is not installed; you can just remove the function entirely.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
The function-style Directive for sphinx app.add_directive is deprecated in Sphinx 1.8, and should be replaced with the class-style directive. This updates
math_symbol_table_directiveto use the new style directive.This will help move towards warnings-free use of sphinx 2.0
I have not added a changelog entry as this is part of the
sphinxextwhich are in thedoc/folder, and so aren't an exposed API – but please let me know if you should add a changelog.PR Checklist