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.

Sign up for GitHub

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

Jump to bottom

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

Open
EFord36 opened this issue Feb 2, 2024 · 2 comments · May be fixed by #44
Open

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

EFord36 opened this issue Feb 2, 2024 · 2 comments · May be fixed by #44

Comments

@EFord36
Copy link

EFord36 commented Feb 2, 2024

Hi,

I was just reading the docs on Rich Tab labels, which currently looks like this:

Screenshot 2024-02-02 at 10 37 47

I think the $2^2$ is meant to be dollar-delimited-math from MyST, but that it isn't rendering properly.

Maybe this is because the dollarmath MyST extension needs to be enabled? According to the docs this should be enabled by a block like:

myst_enable_extensions = [
    "dollarmath",
]

in the docs/conf.py of sphinx-inline-tabs - but I don't see this present. I could be misdiagnosing this thought, but thought it was worth mentioning. I'll keep looking and see if I can find a resolution (and if so, open a PR).
@EFord36
Copy link
Author

EFord36 commented Feb 2, 2024 •
edited
Loading

Just confirmed my attempted diagnosis - if I add the below to the conf.py:

myst_enable_extensions = [
    "dollarmath",
]

then it renders as I would expect:

Screenshot 2024-02-02 at 11 49 12

I'll open a PR (although I hacked around the install locally - I found trying to install with flit I got an error:

flit install --deps=production --extras docs 
Use [project] table for metadata or [tool.flit.metadata], not both.

but this may be me running the wrong command and/or not understanding flit since I haven't used it before.

There's so few dependencies though that I just installed them 'by hand' in a 'virtualenv', and built the docs locally before and after the change.

@EFord36 EFord36 linked a pull request Feb 2, 2024 that will close this issue
Open
@EFord36 EFord36 changed the title Inline math Rich tab able doesn't render right on https://sphinx-inline-tabs.readthedocs.io/ Inline 'dollarmath' math Rich tab labels doesn't render right on https://sphinx-inline-tabs.readthedocs.io/ Feb 2, 2024
@EFord36 EFord36 changed the title Inline 'dollarmath' math Rich tab labels doesn't render right on https://sphinx-inline-tabs.readthedocs.io/ Inline 'dollarmath' Rich tab labels doesn't render right on https://sphinx-inline-tabs.readthedocs.io/ Feb 2, 2024
@EFord36 EFord36 changed the title Inline 'dollarmath' Rich tab labels doesn't render right on https://sphinx-inline-tabs.readthedocs.io/ Inline 'dollarmath' rich tab labels doesn't render right on https://sphinx-inline-tabs.readthedocs.io/ Feb 2, 2024
@EFord36 EFord36 changed the title Inline 'dollarmath' rich tab labels doesn't render right on https://sphinx-inline-tabs.readthedocs.io/ Inline 'dollarmath' rich tab label doesn't render right on https://sphinx-inline-tabs.readthedocs.io/ Feb 2, 2024
@nineteendo
Copy link
Contributor

I'll open a PR (although I hacked around the install locally - I found trying to install with flit I got an error:

See issue #45.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix MyST dollarmath rendering EFord36/sphinx-inline-tabs
2 participants
@EFord36 @nineteendo