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

Non-unique heading anchors on pip-tools' changelog documentation #1935

Closed
atugushev opened this issue Jul 24, 2023 · 2 comments · Fixed by #1945
Closed

Non-unique heading anchors on pip-tools' changelog documentation #1935

atugushev opened this issue Jul 24, 2023 · 2 comments · Fixed by #1945
Labels
bug Something is not working docs Documentation related

Comments

@atugushev
Copy link
Member

What's the problem this feature will solve?

Currently, pip-tools generates non-unique anchors for links in the documentation, as seen for example here: https://pip-tools.readthedocs.io/en/latest/changelog/#id1. This will led to confusion with links for future versions deployed on RTD.

Describe the solution you'd like

Generate unique anchors, for example https://pip-tools.readthedocs.io/en/latest/changelog/#710-2023-07-18

Alternative Solutions

N/A

Additional context

@atugushev atugushev added bug Something is not working docs Documentation related labels Jul 24, 2023
@atugushev atugushev changed the title Generate unique anchors in pip-tools' changeling documentation Generate unique anchors on pip-tools' changelog documentation Jul 24, 2023
@atugushev atugushev changed the title Generate unique anchors on pip-tools' changelog documentation Non-unique heading anchors on pip-tools' changelog documentation Jul 24, 2023
@chrysle
Copy link
Contributor

chrysle commented Jul 25, 2023

Related: sphinx-doc/sphinx#4814

@atugushev
Copy link
Member Author

Fixed in #1942 using sphinx.transform.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something is not working docs Documentation related
Projects
None yet
2 participants