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

MAINT: update the list of sphinx math extensions, and use mathjax by default #10

Merged
merged 5 commits into from
Dec 29, 2014

Conversation

argriffing
Copy link

This PR also uses a sphinx literal code import to show the list of extensions, rather than copypasting that part of the conf.py file into extensions.rst. This should prevent the two lists from diverging.

closes #5

@argriffing
Copy link
Author

I'm adding the ipython directive change #9 into this PR, so
closes #1
closes #6

@argriffing
Copy link
Author

Using mathjax by default should also fix the image link brokenness of the inline math in the online example at http://matplotlib.org/sampledoc/extensions.html#using-math.

@argriffing
Copy link
Author

I see that ipython_console_highlighting is now built into IPython, so I'll add a commit to remove that custom extension and change the conf.py to point to IPython.

https://github.com/ipython/ipython/blob/2.3.x/IPython/sphinxext/ipython_console_highlighting.py

@argriffing
Copy link
Author

OK that should be enough...

@@ -20,18 +20,22 @@

# -- General configuration -----------------------------------------------------

# this line tells sampledoc where the extensions begin
Copy link
Member

Choose a reason for hiding this comment

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

this is un-necessary

@argriffing
Copy link
Author

oh, i see what you did - this makes it hard to read the docs unrendered...

@ivanov Do you have another suggestion? Two alternatives would be 1) copy and paste the extension list into the .rst file 2) Hard-code the line numbers 42-51 into the .rst file. Both of those solutions would make the unrendered .py code easier to read, but both would cause the docs to become de-synchronized from the conf.py file and would cause problems when the conf file is modified in the future. Option (1) would make the unrendered docs easy to read, but they would still look cryptic with option (2).

@argriffing
Copy link
Author

@ivanov I've changed it back to using code copypasted from the conf file

@argriffing
Copy link
Author

Updated a directory listing hardcoded into the docs. This reflects the removal of .py files from sphinxext.

Feel free to review this; I don't have any other changes in mind for this PR.

@argriffing
Copy link
Author

Should I break this up into multiple conflicting PRs?

@tacaswell
Copy link
Member

These changes all seem fine to me and I see no reason to break them up.

@argriffing
Copy link
Author

Cool.

tacaswell added a commit that referenced this pull request Dec 29, 2014
MAINT : update the list of sphinx math extensions, and use mathjax by default
@tacaswell tacaswell merged commit 333f736 into matplotlib:master Dec 29, 2014
@tacaswell
Copy link
Member

@argriffing Thanks for working on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

mathjax
4 participants