question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Use sphinx-math-dollar for Math formula in API documentation

See original GitHub issue

Just found sphinx-math-dollar from this post: https://www.asmeurer.com/blog/posts/quansight-labs-work-update-for-september-2019/ .

Currently, the API documentation of GAlgebra splits into two scattered pieces:

  1. The old doc on the API converted from @abrombo 's original doc in LaTeX, it’s great but it’s somehow outdated (@abrombo has some updates on the doc and yet to be merged )
  2. The API document automatically generated from docstrings in code but it’s mostly ill-formated.

1 is at https://galgebra.readthedocs.io/en/latest/galgebra_guide.html#Module-Components 2 is at https://galgebra.readthedocs.io/en/latest/api.html .

The scenario causes maintenance burden and one of the reasons why @abrombo preferred to work on a separate repo is that it’s difficult to maintain LaTeX doc and Sphinx doc (but there wasn’t such an automatic API doc back then) at the same time.

By ill-formatted, I mean:

image

It’s still parseable but cumbersome. I was aware of this situation but I felt unwilling to rewrite them in the verbose syntax of reStructuredText so I left them there and treated them like plain text.

Now, with the help of sphinx-math-dollar which SymPy is also using, the situation can be fixed. So I opened this issue to add this work to the backlog.

However, this does not solve the maintenance burden issue which I only mentioned it as a context and comments and suggestions are welcome @abrombo @hugohadfield @eric-wieser .

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
eric-wiesercommented, Oct 25, 2019

I suppose either is fine - my point was that the dollar support is purely a convenience thing, and the latex rendering can be obtained with or without it. If the convenience is valuable, then by all means use it!

(Having said that, I just configured my editor to render :math: inline so am now biased)

1reaction
asmeurercommented, Oct 18, 2019

If you use it let us know if you have any issues or feedback about it.

Read more comments on GitHub >

github_iconTop Results From Across the Web

sphinx-math-dollar documentation - SymPy
sphinx-math-dollar is a Sphinx extension to let you write LaTeX math in RST using $$. The mathjax_config is needed to prevent MathJax from...
Read more >
Writing mathematical expressions - GitHub Docs
Writing dollar signs in line with and within mathematical expressions. Further reading. Use Markdown to display mathematical expressions on GitHub.
Read more >
Mathematical Formulas | Infographics - Google Developers
You can generate an image of a mathematical formula using the TeX language (pronounced "tek" or "tech"). This is useful for displaying complex...
Read more >
Formula API - FactSet Developer Portal
FactSet Formula API. FactSet's Formula API is a modern, flexible, formula-based API that enables users to access FactSet's wide range of financial data...
Read more >
Math equations – Notion Help Center
This comes in handy for note taking, technical documentation, homework, or anywhere you need to use fractions and equations 🧮.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found