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.

Sign up for GitHub

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

Jump to bottom

[L] Divergent links (same name, different URLs) #88

Open
3 tasks
Tracked by #72
gabalafou opened this issue May 28, 2024 · 2 comments
Open
3 tasks
Tracked by #72

[L] Divergent links (same name, different URLs) #88

gabalafou opened this issue May 28, 2024 · 2 comments
Labels
area: accessibility ♿ area: PyData-Sphinx size: L More than 1-2 weeks

Comments

@gabalafou
Copy link
Contributor

gabalafou commented May 28, 2024 •
edited
Loading

Divergent links (term I invented) - two or more links that have the same name but go to different URLs.

These are particularly bad for people who use speech command software.

Tasks
Preview Give feedback
@gabalafou gabalafou mentioned this issue May 28, 2024
Open
@gabalafou gabalafou changed the title Are there any divergent links? Find and fix all divergent links (same name, different URLs) Divergent links (same name, different URLs) May 28, 2024
@gabalafou gabalafou mentioned this issue May 29, 2024
Merged
9 tasks
@gabalafou
Copy link
Contributor Author

Tania says that PST does not have the ability to run checks on the content for theme adopters.

Bonus task: Could be useful to have a GitHub action that checks for divergent links.

@gabalafou gabalafou changed the title Divergent links (same name, different URLs) [L] Divergent links (same name, different URLs) May 30, 2024
@gabalafou
Copy link
Contributor Author

I marked this as a large task because it's quite a bit of effort to go through every link on every page of the docs.

Might be better to create some code or GitHub action to do this, but that is also considerable time.

@gabalafou gabalafou moved this from 📬 TODO to Dev in czi-scientific-python 🐍 May 31, 2024
@gabalafou gabalafou added the size: L More than 1-2 weeks label May 31, 2024
@gabalafou gabalafou moved this from Dev to 📬 TODO in czi-scientific-python 🐍 Jun 4, 2024
@Carreau Carreau mentioned this issue Aug 29, 2024
Open
Carreau added a commit to Carreau/pydata-sphinx-theme that referenced this issue Aug 29, 2024
@Carreau
Draft script to find divergin links
0e633d9 
See Quansight-Labs/czi-scientific-python-mgmt#88

Incomplete, in particular we should handle relative and anchor linsks,
starting with #, and .

$ python tools/divergent_links.py docs/_build/html
@Carreau Carreau mentioned this issue Aug 29, 2024
Merged
Carreau added a commit to Carreau/pydata-sphinx-theme that referenced this issue Sep 12, 2024
@Carreau
Draft script to find diverging links
623192a 
See Quansight-Labs/czi-scientific-python-mgmt#88

Incomplete, in particular we should handle relative and anchor links,
starting with #, and .

$ python tools/divergent_links.py docs/_build/html
Carreau added a commit to Carreau/pydata-sphinx-theme that referenced this issue Sep 12, 2024
@Carreau
Draft script to find diverging links
715febd 
See Quansight-Labs/czi-scientific-python-mgmt#88

Incomplete, in particular we should handle relative and anchor links,
starting with #, and .

$ python tools/divergent_links.py docs/_build/html
drammock added a commit to pydata/pydata-sphinx-theme that referenced this issue Oct 7, 2024
@Carreau @gabalafou
@pre-commit-ci @drammock
Draft script to find diverging links (#1966)
5135b8f 
See
Quansight-Labs/czi-scientific-python-mgmt#88

Incomplete, in particular we should handle relative and anchor linsks,
starting with #, and .
```
$ python tools/divergent_links.py docs/_build/html
```

---------

Co-authored-by: gabalafou <gabriel@fouasnon.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Daniel McCloy <dan@mccloy.info>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: accessibility ♿ area: PyData-Sphinx size: L More than 1-2 weeks
Projects
czi-scientific-python 🐍
Status: 📬 TODO
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gabalafou @trallard