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

Broken hyperlinks in home page #1122

Closed
claird opened this issue Oct 30, 2019 · 3 comments
Closed

Broken hyperlinks in home page #1122

claird opened this issue Oct 30, 2019 · 3 comments
Labels
T: documentation Improvements to the docs (e.g. new topic, correction, etc)

Comments

@claird
Copy link

claird commented Oct 30, 2019

Intra-page hyperlinks of the home page don't resolve, because target anchors are missing.

Example: https://pypi.org/project/black/#change-log does not display the Change Log section, because the Change Log heading lacks its intended anchor:

    ...
<p>More details can be found in <a href=CONTRIBUTING.md rel=nofollow>CONTRIBUTING</a>.</p>
<h2>Change Log</h2>
<h3>19.10b0</h3>
<ul>
    ...
@claird claird added the T: bug Something isn't working label Oct 30, 2019
@hugovk
Copy link
Contributor

hugovk commented Oct 30, 2019

They work at https://github.com/psf/black because of the way GitHub processes the Markdown.

@claird-ot
Copy link

Ha! I see. Thank you, Hugo.

@ichard26 ichard26 added T: documentation Improvements to the docs (e.g. new topic, correction, etc) and removed T: bug Something isn't working labels Sep 20, 2020
@ichard26
Copy link
Collaborator

No longer relevant as the TOC doesn't exist after my documentation reorganization effort: #2174.

Thanks for noticing though!

(p.s. I probably would've used <h1 id="change-log">Change Log</h1> to fix this)
(p.s.s I just noticed the changelog is referenced twice in the distribution's long description, we should probably fix that, that's a new issue tho)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Development

No branches or pull requests

4 participants