-
Notifications
You must be signed in to change notification settings - Fork 92
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
MAINT: update the list of sphinx math extensions, and use mathjax by default #10
Conversation
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. |
I see that https://github.com/ipython/ipython/blob/2.3.x/IPython/sphinxext/ipython_console_highlighting.py |
OK that should be enough... |
@@ -20,18 +20,22 @@ | |||
|
|||
# -- General configuration ----------------------------------------------------- | |||
|
|||
# this line tells sampledoc where the extensions begin |
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.
this is un-necessary
@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). |
@ivanov I've changed it back to using code copypasted from the conf file |
…om the sphinxext directory
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. |
Should I break this up into multiple conflicting PRs? |
These changes all seem fine to me and I see no reason to break them up. |
Cool. |
MAINT : update the list of sphinx math extensions, and use mathjax by default
@argriffing Thanks for working on this. |
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