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

Restrict display math further? #15

Open
asmeurer opened this issue Oct 4, 2019 · 5 comments
Open

Restrict display math further? #15

asmeurer opened this issue Oct 4, 2019 · 5 comments

Comments

@asmeurer
Copy link
Member

asmeurer commented Oct 4, 2019

See #12. Display math is currently allowed everywhere inline math is. But that includes things like headers, where display math doesn't make any sense. Should we restrict it? My feeling is we should probably just let it work, as people won't likely do it anyway, but I don't feel strongly about it.

@asmeurer asmeurer changed the title Restrict display math further Restrict display math further? Oct 4, 2019
@vonopr
Copy link

vonopr commented Sep 22, 2020

What are drawbacks of using math in headers? I am going to use it and care about reasons why I should not.

@vonopr
Copy link

vonopr commented Sep 22, 2020

Now, links pointing to seactions with math symbols are not rendered right:
math_symbol_in_sphinx_header

source:

.. _scalars:

######################
Calculation of Scalars
######################

.. contents:: :local:


*****************************
Update T,S and $\rho$ scalars
*****************************

@asmeurer
Copy link
Member Author

Is this something that broke in the most recent 1.2 release?

@asmeurer
Copy link
Member Author

If I understand correctly, your issue is that the rho is not blue in the link text? I just tested your example and it seems to render fine in both 1.1.1 and 1.2. Perhaps this is an issue with the CSS of the theme you are using.

@asmeurer
Copy link
Member Author

As to the original question, this is specifically about restricting display math. Inline math should definitely be allowed in headers. But I don't know if it makes sense for display math (double dollars), whose support was just added in 1.2.

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

No branches or pull requests

2 participants