Skip to content

Regenerate documentations with math so that formulas render (follow-up to #2752) #2763

Closed

Description

@ridge-kimani

Documentation style bug

Summary

#2752 added a MathFilter that converts Sphinx/MathJax math markup to native MathML at scrape time (closes #1264). It's opt-in per scraper, and it's enabled for scikit-learn, NumPy, scikit-image, Polars and Statsmodels. The pages on devdocs.io still show raw LaTeX, though, because those documentations were scraped before that change. Each one needs to be regenerated with the new filter and uploaded by a maintainer (thor docs:upload + deploy).

This issue tracks that regeneration. Versions are the ones in the October 2026 report (#2744).

Documentations with the filter enabled, to regenerate:

Documentations that also contain math but don't enable the filter yet (adding math to their html_filters and checking the output would be a separate PR each):

PyTorch ships its own pre-rendered MathML and isn't affected.

I'll send a version-update PR per documentation, following section B of the PR template, starting with scikit-learn. Maintainers: if you'd rather regenerate some of these directly, please tick them off here.

Actual style

https://devdocs.io/scikit_learn/modules/lda_qda shows \(x \in \mathbb{R}^d\) style TeX as plain text (see the screenshots in #1264).

Expected style

Rendered MathML, as on https://devdocs.io/pytorch/generated/torch.nn.batchnorm3d and in the before/after screenshots in #2752.

Activity

  1. ridge-kimani commented on Oct 16, 2026

    @ridge-kimani
    Author

    Status after regenerating each documentation locally with the filter from #2752:

    One kind of math was still left unrendered across all of them: Sphinx emits align* and similar environments without \[...\] delimiters. #2766 handles those.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions