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

math_role and MathDirective in sphinx 1.8? #5463

Closed
paugier opened this issue Sep 21, 2018 · 2 comments
Closed

math_role and MathDirective in sphinx 1.8? #5463

paugier opened this issue Sep 21, 2018 · 2 comments

Comments

@paugier
Copy link

paugier commented Sep 21, 2018

I use

from sphinx.ext.mathbase import MathDirective, math_role

in https://bitbucket.org/fluiddyn/fluiddyn/src/default/fluiddoc/mathmacro.py

Both names have been removed from the mathbase module in sphinx 1.8.

I managed to find that MathDirective is now in sphinx.directives.patches.

math_role has been removed in 4e04bff (by @tk0miya )

I didn't find anything in the documentation on why these class/function have been removed.

Can I still do something like what is done in https://bitbucket.org/fluiddyn/fluiddyn/src/default/fluiddoc/mathmacro.py with sphinx 1.8 ?

@tk0miya
Copy link
Member

tk0miya commented Sep 21, 2018

Oh, sorry. It was not intended change. I'll re-add them to keep compatibility.

I didn't find anything in the documentation on why these class/function have been removed.

As the commit message of 4e04bff, math directive and role are moved to core package. So they were merged to core. The math directive was moved sphinx.directives.patches. On the other hand, the math role was removed because we uses docutils' implementation.

@tk0miya tk0miya added this to the 1.8.1 milestone Sep 21, 2018
tk0miya added a commit to tk0miya/sphinx that referenced this issue Sep 21, 2018
tk0miya added a commit to tk0miya/sphinx that referenced this issue Sep 21, 2018
tk0miya added a commit that referenced this issue Sep 21, 2018
Fix #5463: mathbase: math_role and MathDirective was disappeared in 1.8.0
@tk0miya
Copy link
Member

tk0miya commented Sep 21, 2018

Fixed by #5464.
But they will be removed in Sphinx-3.0.
So please move to new ones until then.

Thanks,

@tk0miya tk0miya closed this as completed Sep 21, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 11, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants