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

Use MathJax for the html docs #3911

Merged
merged 2 commits into from
Aug 31, 2014
Merged

Use MathJax for the html docs #3911

merged 2 commits into from
Aug 31, 2014

Conversation

ev-br
Copy link
Member

@ev-br ev-br commented Aug 28, 2014

[ci skip]

`make html-scipyorg` places files into doc/build/html-scipyorg
not doc/build/html
@rgommers
Copy link
Member

Can you summarize why using MathJax is a good thing?

@ev-br
Copy link
Member Author

ev-br commented Aug 29, 2014

Uhm, well... it just makes maths look cleaner and nicer and more modern overall so to speak.
I think it's close to a de facto standard for typesetting math in browser, used by mathoverflow, APS journals, Elsevier, arXiv.org etc.

A downside to using it is that html docs need a working internet connection [or maybe you can download the whole javascript CDN somehow]. But I'd argue that offline usage is precisely what pdf docs are for.

BTW here's the start of the discussion (filed to a wrong tracker, closed) scipy/scipy.org#50.

@josef-pkt
Copy link
Member

Related aside: the two distribution files in the stats tutorial will be a heavy load on the browser and should be split up.

@rgommers
Copy link
Member

Thanks. Requiring an internet connection for rendered LaTeX doesn't seem like an unreasonable restriction.

@rgommers rgommers added this to the 0.15.0 milestone Aug 31, 2014
@rgommers
Copy link
Member

OK, works well for me, so merging. Thanks @ev-br

rgommers added a commit that referenced this pull request Aug 31, 2014
Use MathJax for the html docs
@rgommers rgommers merged commit b4be7bf into scipy:master Aug 31, 2014
@rgommers
Copy link
Member

@josef-pkt indeed those files should be split. The continuous one took 5 seconds on my laptop to finish rendering the math.

@rgommers
Copy link
Member

I'll add a new issue.

@ev-br
Copy link
Member Author

ev-br commented Aug 31, 2014

Wow Ralf, your laptop is fast :-).
As much as I hate the whole "you're always online" thing, I still think using png images for maths is simply not right.

@WarrenWeckesser
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org Website Items related to the website; please also check https://github.com/scipy/scipy.org
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants