MunchLab / ect

Code for computing the Euler Characteristic Transform (ECT)
https://munchlab.github.io/ect/
GNU General Public License v3.0
1 stars 0 forks source link

math in documentation #2

Closed lizliz closed 3 months ago

lizliz commented 7 months ago

I'm trying to get latex show up in the autodocumentation.

I can get math in the main markdown files by writing the following

  Testing {math}`a^2 + b^2 = c^2` with some text 

  An inline text shows up like
  '''{math}
  a^2 + b^2 = c^2
  '''
  although the three slashes need to be the ` near the 1 key but that won't render in this format.

However, everything I've tried when I've put the math stuff inside of the .py files for the autodocumentation does not render as math. You can see lots of examples of this not working in the top of the ect on graphs documentation page. This code is rendered from the documentation in the top of the ect_graph.py class.

Pretty sure I've had this issue in teaspoon too so maybe once we fix it here we can get that fixed too.