Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: allow math in rst #246

Merged
merged 1 commit into from
Jul 19, 2022
Merged

Conversation

miketheman
Copy link
Member

The first step to allowing math directives to be rendered on PyPI is
to enable the directive's warning to pass.

docutils tells us to pass a path to the math_output setting.
Since we clean the output, we can pass anything we want, as control
of the CSS will be handed on PyPI.

Refs: https://docutils.sourceforge.io/docs/user/config.html#math-output

This does not solve for Markdown math.

Resolves #115
Resolves #172

Once merged and released, I'll explore what it takes to get the MathJax JS working on the warehouse.

The first step to allowing math directives to be rendered on PyPI is
to enable the directive's warning to pass.

`docutils` tells us to pass a path to the `math_output` setting.
Since we `clean` the output, we can pass anything we want, as control
of the CSS will be handed on PyPI.

Refs: https://docutils.sourceforge.io/docs/user/config.html#math-output

This does **not** solve for Markdown math.

Resolves pypa#115
Resolves pypa#172

Signed-off-by: Mike Fiedler <miketheman@gmail.com>
@di di merged commit e52f968 into pypa:main Jul 19, 2022
@miketheman miketheman deleted the miketheman/enable-math-in-rst branch July 19, 2022 16:12
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.

Docutils settings make math rendering fail in Docutils 0.14+ Add support for the math directive
2 participants