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

Web documentation has hyperlinks to geopm repository pages that no longer exist #3431

Open
dannosliwcd opened this issue May 3, 2024 · 0 comments
Labels

Comments

@dannosliwcd
Copy link
Contributor

Describe the bug
Some pages (e.g., geopm_pio.3.rst) link to files in our old repository layout (service/src/geopm_pio.h which should be libgeopmd/include/geopm_pio.h)

GEOPM version
7594052

Expected behavior
All hyperlinks in the web documentation point to destinations that exist.

Actual behavior
Some links to our source code point to destinations that no longer exist in the latest dev branch.

Error messages produced
404 - page not found

Additional context
This issue can be found along with other similar issues through sphinx automation. Use that tool to help find related dead links.

In the docs directory, run sphinx-build -b linkcheck source build to check all hyperlinks. It will point out permanent redirects, dead links, and some transient failures. We should deal with all 404s and maybe canonicalize permanent redirects if any are found.

@dannosliwcd dannosliwcd added the bug label May 3, 2024
@dannosliwcd dannosliwcd changed the title Some of our web documentation has hyperlinks to geopm repository pages that no longer exist Web documentation has hyperlinks to geopm repository pages that no longer exist May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant