Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix MyST dollarmath rendering #44

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

EFord36
Copy link

@EFord36 EFord36 commented Feb 2, 2024

Closes #43

The relevant MyST extension was not previously enabled as required.

As mentioned in #43, I've tested this locally by building the docs without this change, and then making the change and seeing the issue be resolved. However, I didn't manage the installation via flit as expected, as I was getting an error trying to use flit. I instead installed the dependencies by hand in a venv created virtual environment since there are so few dependencies, it was straightforward to do so. I'm assuming CI etc. will provide reassurance in a repeatable/isolated install that this resolves the issue and doesn't introduce any new problem.

@EFord36 EFord36 changed the title Fix MyST dollasign math rendering Fix MyST dollarsign math rendering Feb 2, 2024
The relevant MyST extension was not previously enabled as required.
@EFord36 EFord36 force-pushed the fix-dollarsign-math-rendering branch from ae6919e to 8fcda60 Compare February 2, 2024 11:56
@EFord36 EFord36 changed the title Fix MyST dollarsign math rendering Fix MyST dollarmath rendering Feb 2, 2024
@EFord36
Copy link
Author

EFord36 commented Feb 2, 2024

Not sure if this is exactly where in the file you will want these lines, or if you will want comment lines to separate this into its own section - happy to make changes as requested, or for you to edit my branch or anything. Just hoping the issue and PR help fix the issue, as a tiny sign of my appreciation for sphinx-inline-tabs and your work more generally (especially Furo I'm a big fan of, and I'm sure your work in python packaging more generally has massively improved my life as a developer, though I don't know the details there).

@EFord36
Copy link
Author

EFord36 commented Feb 2, 2024

possibly the docs should also be changed to point out that if a user of sphinx-inline-tabs wanted dollarmath to work as in the example, they also need to do this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inline 'dollarmath' rich tab label doesn't render right on https://sphinx-inline-tabs.readthedocs.io/
1 participant