Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Unbreak the Sphinx 1.8 build by renaming :math: to :mathmpl:. #12128

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 15, 2018
Merged

Unbreak the Sphinx 1.8 build by renaming :math: to :mathmpl:. #12128

merged 1 commit into from
Sep 15, 2018

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Sep 15, 2018

PR Summary

Would be kind of nice to have for 3.0, but heh.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@anntzer anntzer added this to the v3.0 milestone Sep 15, 2018
jklymak
jklymak approved these changes Sep 15, 2018
View reviewed changes
Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow great. The only question I’d have is why we can’t use the Sphinx math directive, it I can believe they are different enough to make that a PITA

@anntzer
Copy link
Contributor Author

anntzer commented Sep 15, 2018

We can (and this PR basically does that implicitly by keeping :math: on the rest of the docs, which will use sphinx's math role), except for the mathtext tutorial because it uses mathtext construct that are not actually valid latex (\mathcircled, #7710 (comment)). My long term plan proposal is to rewrite the mathtext tutorial to just use the .. plot:: instead and completely kill :mathmpl: (even if you're using older versions of sphinx they also provide :math:, you just needed to add sphinx.ext.pngmath to the extensions list instead of being active by default).

This PR is just a stopgap fix.

@tacaswell tacaswell merged commit 2188358 into matplotlib:master Sep 15, 2018
@lumberbot-app
Copy link

lumberbot-app bot commented Sep 15, 2018

Something went wrong ... Please have a look at my logs.

@anntzer anntzer deleted the sphinx18math branch September 15, 2018 18:45
tacaswell added a commit to tacaswell/matplotlib that referenced this pull request Sep 15, 2018
@tacaswell
Merge pull request matplotlib#12128 from anntzer/sphinx18math
a0088e5 
FIX: Unbreak the Sphinx 1.8 build by renaming :math: to :mathmpl:.
This was referenced Sep 18, 2018
Merged
Merged
@ImportanceOfBeingErnest
Copy link
Member

ImportanceOfBeingErnest commented Sep 19, 2018 •
edited
Loading

In the Writing mathematical expressions tutorial there are now strange red symbols appearing

image

image

which have not been there in the previous version.

Is this a consequence of this PR?

tacaswell added a commit to tacaswell/matplotlib that referenced this pull request Feb 12, 2019
@tacaswell
Merge pull request matplotlib#12128 from anntzer/sphinx18math
2ace240 
FIX: Unbreak the Sphinx 1.8 build by renaming :math: to :mathmpl:.

Conflicts:
	lib/matplotlib/sphinxext/mathmpl.py
          - import cleanups
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jklymak jklymak jklymak approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.0.0
Development

Successfully merging this pull request may close these issues.
4 participants
@anntzer @ImportanceOfBeingErnest @jklymak @tacaswell