pypa / readme_renderer

Safely render long_description/README files in Warehouse
Apache License 2.0
158 stars 88 forks source link

fix: allow math in rst #246

Closed miketheman closed 1 year ago

miketheman commented 2 years ago

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.