sphinx-doc / sphinx-doc/sphinx

MathML default output for Math

Open
#6,092 22 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

builder:html extensions:mathematics help wanted markup type:enhancement type:proposal
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the documentation passage quoted in the issue and the discussion about MathML and HTML5 support. Determine the intended default output behavior and identify the relevant Sphinx math-rendering entry point; done means the decision is implemented and its documentation and coverage reflect the agreed behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.