search

sympy / sphinx-math-dollar

Sphinx extension to let you write LaTeX math using $$
https://www.sympy.org/sphinx-math-dollar/
MIT License
33 stars 11 forks source link

Changelog is necessary #32

Open thclark opened 2 years ago

thclark commented 2 years ago

Hi folks, I'm the maintainer of sphinx-charts, we use this library a lot so latex can be rendered in scientific charts. So first of all a big thank you, I'm a huge fan of this library!

I'm wondering if it's possible for you to start adding a changelog to this library, please? It's difficult to keep up with any changes particularly breaking ones (the move from mathjax 2.x to 3.x broke sphinx charts in a difficult to spot way, for example).

Over at octue (my main gig) we've done a lot on release management and have built tools based on conventional-commits to help generate release notes automatically. I use them on the sphinx-charts repo, for example... and we'll gladly share experience with you and have a chat around the subject if that'd be useful for you :)

asmeurer commented 2 years ago

We do have a changelog here https://github.com/sympy/sphinx-math-dollar/blob/master/CHANGELOG.rst. I guess we don't have it linked to in the README, but it is linked in the docs.

MathJax 2 to 3 should be independent of this library, although you do have to update your config (see the example in the README https://github.com/sympy/sphinx-math-dollar).

If any other changes were breaking, that was unintentional, so please let us know. I'd like for this library to remain as stable as possible so that people don't have to worry about that sort of thing.