QuantEcon / QuantEcon/quantecon-sphinx-theme

Inline $...$ math does not render correctly

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug high-priority
Dominant language
SCSS
Stars
0
Forks
0
Avg merge
3h 29m
Merged PRs (30d)
1

Description

Inline $...$ math does not render correctly. Reported during the theme evaluation in QuantEcon/lecture-python-programming#475 (closed, never merged).

Context. The evaluation built the QuantEcon Python Programming lectures against main at 6a22984 — the current and only HEAD of this repo, which already includes both mathjax commits (fdc28b9 feat: auto-enable sphinx.ext.mathjax in theme setup and 5629fed fix(mathjax): use Sphinx's mathjax3_config instead of raw script tag). So this is not a case of an untested fix: the defect reproduces against the theme's final state.

Preview build: https://699d241d064feca2f249791b--epic-agnesi-957267.netlify.app/intro

inline math not rendering inline math not rendering (second example)

Why it matters. Inline math is pervasive across QuantEcon lecture content — this blocks any serious evaluation of the theme on real scientific material. quantecon-book-theme renders the same source correctly, so the source markup is not at fault.

Suggested starting points: confirm mathjax3_config is reaching the rendered page, check whether MathJax's inline delimiters ($...$) are enabled — MathJax 3 disables single-$ inline math by default unless inlineMath is configured — and verify against docs/kitchen-sink.md, which should grow an inline-math case if it lacks one.

Contributor guide

No contributing guide indexed for this repository

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 inspecting the theme's MathJax setup and confirm whether mathjax3_config reaches the rendered page. Use docs/kitchen-sink.md to add or verify an inline $...$ example, then build the documentation and confirm that single-dollar inline math renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, scss
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
74/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.