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

Examples in different files have same labels (e.g., 'example-0') #79

Open
photong opened this issue May 20, 2022 · 1 comment
Open

Examples in different files have same labels (e.g., 'example-0') #79

photong opened this issue May 20, 2022 · 1 comment
Labels
bug Something isn't working

Comments

@photong
Copy link

photong commented May 20, 2022

Describe the bug

When I add the prf:example directive in two different files (foo.rst and bar.rst), the first
example for each file is labeled 'example-0'.

This leads to

foo.rst: WARNING: duplicate example label 'example-0', other instance in bar.rst

when I run "make html". The examples have correct labels in the HTML output, so the main problem is the large number of warnings during compile time (with hundreds of examples, it becomes difficult to see other warnings).

The duplication seems to be caused by the use of serial_no = env.new_serialno() in directive.py. According to the Sphinx documentation for new_serialno:

The number is guaranteed to be unique in the current document.

Is it possible to get a unique number per example in a project?

Reproduce the bug

  1. Create a file with prf:example directive.
  2. Create another file with prf:example directive.
  3. Add both files to a toctree.
  4. Note warning during sphinx-build.

List your environment

Sphinx 4.5
sphinx_proof extension (no other extensions)

@photong photong added the bug Something isn't working label May 20, 2022
@welcome
Copy link

welcome bot commented May 20, 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