Mirror of forum.nim-lang.org

6757 :: formatted math in documentation?

[2020-09-01T22:05:13+02:00]

BarrOff25 (orginal) [2020-09-01T22:05:13+02:00] view original

Hello, I tried to add formatted math to the documentation.

According to Sphinx documentation inline math or indented math can be put into reStructuredText using the directive math. However, using this and running nim doc on the code tells me that math is an invalid directive.

Is there an "official" way to put formatted math into documentation or is it not possible at all?

juancarlospaco (orginal) [2020-09-01T22:12:16+02:00] view original

htmlgen supports MathML thats basically Latex on HTML vanilla, is an ISO standard, looks nice on Firefox.

https://nim-lang.org/docs/htmlgen.html#mathml

Also you can generate SVG using the XML modules, works too.

Theres packages or easy SVG generation on Nimble.

Yardanico (orginal) [2020-09-01T22:17:08+02:00] view original

He's asking about an entirely different thing - inline math formulas IN the nim documentation :) But yeah, @BarrOff25, you can convert them to images (e.g. svg) and embed in the documentation

BarrOff25 (orginal) [2020-09-01T22:31:34+02:00] view original

@Yardanico is right, I need it inside the documentation of my project. In normal markdown you can write the equations using LaTeX-notation, surrounded by backticks and it gets rendered quite well. I would like to do get the same results in rst.

Araq (orginal) [2020-09-01T23:02:52+02:00] view original

We should support .. math::, PRs are welcome.

You can use .. raw:: html to embed HTML directly and given the right JavaScript voodoo, I'm sure you can avoid HTML's math syntax and opt-into something more LaTeX like.