Skip to content

chore: use KaTeX Sphinx plugin#446

Merged
flying-sheep merged 7 commits intomainfrom
pa/katex
Nov 21, 2025
Merged

chore: use KaTeX Sphinx plugin#446
flying-sheep merged 7 commits intomainfrom
pa/katex

Conversation

@flying-sheep
Copy link
Member

@flying-sheep flying-sheep commented Nov 20, 2025

KaTeX renders to static HTML and doesn’t re-layout the page a fraction of a second after load.

compare (you might have to use devtools to see it if you have the page in cache):

mathjax: https://docs.scvi-tools.org/en/stable/api/reference/scvi.model.base.DifferentialComputation.html#scvi.model.base.DifferentialComputation.get_bayes_factors

katex-pre-render: https://cookiecutter-scverse-instance--237.org.readthedocs.build/en/237/generated/cookiecutter_scverse_instance.pp.elaborate_example.html

@github-actions
Copy link

A PR has been generated to the instance repo:
scverse/cookiecutter-scverse-instance#237

You can check out the PR to preview your changes
in an instance of the cookiecutter template. The PR will be kept in sync with
this PR automatically.

@flying-sheep flying-sheep requested review from Zethson and grst November 20, 2025 16:41
Copy link
Collaborator

@grst grst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one minor concern that it's one additional thing that can go wrong while building docs. But it's probably fine.

@flying-sheep
Copy link
Member Author

I think it would take a truly ancient version of nodejs being present to break this.

This was referenced Dec 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants