-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
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
Use sphinx builtin only directive instead of custom one. #11295
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we deprecate only_directives.py
instead of just deleting it?
If we want to be very strict in our deprecation policy, yes. However, the only use case for these would be in the documentation of downstream projects. Building documentation is happening pre-release, so they will notice and can simply replace the expressions. The only advantage of a deprecation would be that the downstream projects have a bit more time for the change. Given the timing (introduced mid 2008, superseeded early 2009 by sphinx directives), I question if anybody else uses our (undocumented) directives at all. I would be practical here and dare removing it straight away. But if you feel a deprecation is better, I can add one. |
Yeah, I think I would be in favour of deprecating just in case, and then removing in |
The problem with deprecation is that most doc builds are already pretty noisy in their warning output. I bet most people won't notice an extra deprecation warning. |
People might notice a deprecation changelog entry though? I'm not too bothered either way about deleting/deprecating, but either way this needs a changelog entry. |
I don't know about you, but I've never got my first warning of a deprecation from a changelog entry. If I see one, or I get an error, then I might go looking. |
Merged. If someone wants to get excited about adding a deprecation, thats fine, but I don't think the case is very strong. |
Can this get a changelog entry? |
Downstream users of this included by day-job 😞 |
This was removed in Matplotlib 3.0 and we did not actually use it xref matplotlib/matplotlib#11295
This was removed in Matplotlib 3.0 and we did not actually use it xref matplotlib/matplotlib#11295
This was removed in Matplotlib 3.0 and we did not actually use it xref matplotlib/matplotlib#11295
PR Summary
Switch from our custom
.. htmlonly::
and.. latexonly::
directives to the sphinx builtin.. only:: html
and.. only:: latex
.AFAICS they do exactly the same. So let's get rid of some proprietary stuff and just use plain sphinx.
Our directives are from mid 2008. Sphinx itself introduced that functionally just slightly later in Release 0.6 (Mar 24, 2009).