argotorg / argotorg/solidity-website

Enable Sphinx math support (`:math:` role) in the docs build

Open Beginner friendly
#211 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
30
Forks
29
Avg merge
8h 15m
Merged PRs (30d)
7

Description

`docs/conf.py` does not enable any Sphinx math extension, so the `:math:` role does not render and the output shows raw MathJax delimiters instead, e.g. `\(-2^{63}\)`.

**Reproduce**: add e.g. ```:math:`2^{63} - 1``` to any .rst page and build the docs, so the formula appears as literal `\(...\)` text.

**Fix**: add `sphinx.ext.mathjax` to `extensions` in `docs/conf.py` (or `sphinx.ext.imgmath` if the rendered site should not load the MathJax script from a CDN).

No page currently uses `:math:`, so in the doc ethdebug page we worked around it with plain literals like ``2**63 - 1``.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start in docs/conf.py and inspect the existing extensions list. Reproduce the issue by adding a :math: role such as `2^{63} - 1` to an .rst page, then build the documentation. Done means the formula renders as math rather than literal MathJax delimiters.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
88/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.