sphinx-doc/sphinx

MathML default output for Math

Open

#6,092 opened on Feb 21, 2019

View on GitHubContributor guide
 (22 comments) (0 reactions) (0 assignees)Python (1,985 forks)batch import
builder:htmlextensions:mathematicshelp wantedmarkuptype:enhancementtype:proposal

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 merged PRs in 30d)

Description

From the docs:

"Since mathematical notation isn’t natively supported by HTML in any way..."

That's not totally true. MathML is a part of the HTML5 spec, though browser support is spotty to say the least. Since the alternative without installing plugins is just math not working, maybe a good default would be to follow the spec for the output format?

Contributor guide

Research direction
Research how Sphinx currently handles math output (e.g., MathJax, imgmath). Identify the code path for math output and where a new MathML builder could be integrated. Study the MathML specification for HTML5 and existing MathML libraries in Python.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinx extension development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40