Mathics3 / mathics-core

An open-source Mathematica. This repository contains the Python modules for WL Built-in functions, variables, core primitives, e.g. Symbol, a parser to create Expressions, and an evaluator to execute them.
https://mathics.org
Other
733 stars 42 forks source link

Improving support for Markdown syntaxis in documentation entries. #1026

Open mmatera opened 3 months ago

mmatera commented 3 months ago

Adding support for markdown notation in figures and references. This would be helpful for a future migration to more standard documentation systems.

rocky commented 3 months ago

Personally, I think markdown at this stage is a bad idea. Sphinx works best with RsT. ad

Also, the regexps to handle this were kind of the wrong way to deal with documentation. Overall I'd like to reduce their use rather than increase their use and add more complexity here.

mmatera commented 3 months ago

Ok, I could add the rules for the RST syntax in another branch.

mmatera commented 3 months ago

Regarding the implementation, I see this as an intermediate step. This is why I tried to split the parts of the documentation system as much as possible.

The long term plan would be