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

Using References in (sub)section titles #85

Open
schwabts opened this issue Aug 19, 2022 · 1 comment
Open

Using References in (sub)section titles #85

schwabts opened this issue Aug 19, 2022 · 1 comment
Labels
bug Something isn't working

Comments

@schwabts
Copy link

Describe the bug

context
When I write a subsection with title

## Sharpening {prf:ref}`weak-lemma`

expectation
I expected the section title to be generated as

Sharpening Lemma 3

and Lemma 3 to become a link to the Lemma which actually happened. So far so good!

But I also expected it to show up the same way in the contents of the respective page on the right hand side where I essentially get a list of sections.

bug
But instead the unresolved label of the reference is written into the contents.

problem
This is a problem for people reading Jupyter Books because they should not (need to) know anything about the label authors use.

Reproduce the bug

  1. Edit a markdown file of a chapter of a Jupyter Book
  2. Add a section with the title
## Sharpening {prf:ref}`weak-lemma` 
  1. Build the Jupyter Book, e.g. jb build book

List your environment

Jupyter Book : 0.13.0
External ToC : 0.2.4
MyST-Parser : 0.15.2
MyST-NB : 0.13.2
Sphinx Book Theme : 0.3.3
Jupyter-Cache : 0.4.3
NbClient : 0.5.3

@schwabts schwabts added the bug Something isn't working label Aug 19, 2022
@welcome
Copy link

welcome bot commented Aug 19, 2022

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant