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

[Docs] Add link checker for docs #475

Merged
merged 9 commits into from
May 14, 2024
Merged

[Docs] Add link checker for docs #475

merged 9 commits into from
May 14, 2024

Conversation

antonymilne
Copy link
Contributor

@antonymilne antonymilne commented May 13, 2024

Description

Add a link checking step to the build of both vizro-ai and vizro-core docs on RTD. There's no good tool built into mkdocs for this, but https://github.com/linkchecker/linkchecker works quite well here and seems fast enough.

We now have three scripts that can be run in the docs environment:

# For local development, since it includes hot reloading:
hatch run docs:serve 
# Used to build docs on RTD but can also be done locally:
hatch run docs:build
hatch run docs:link-check

@stichbury I've fixed/ignored all the errors I found apart from this one, where I can't find an authoritative-looking link to the INCITS guidelines that actually works. Please can you suggest something?

URL        `https://standards.incits.org/apps/group_public/download.php/131246/eb-2021-00288-001-INCITS-Inclusive-Terminology-Guidelines.pdf'
Name       `INCITS Inclusive Terminology Guidelines'
Parent URL file:///home/docs/checkouts/readthedocs.org/user_builds/vizro/checkouts/475/vizro-core/site/pages/explanation/documentation-style-guide/index.html, line 2257, col 316
Real URL   https://incits.connectedcommunity.org/higherlogic/ws/public/download/131246/
Check time 0.605 seconds
Warning    [http-redirected] Redirected to
           `https://incits.connectedcommunity.org/higherlogic/ws/public/download/131246/'
           status: 301 Moved Permanently.
Result     Error: 404 Not Found

Screenshot

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:24 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:24 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:24 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:24 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:24 — with GitHub Actions Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to vizro_ai_secrets May 13, 2024 15:25 Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to vizro_ai_secrets May 13, 2024 15:25 Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to vizro_ai_secrets May 13, 2024 15:25 Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to vizro_ai_secrets May 13, 2024 15:25 Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to vizro_ai_secrets May 13, 2024 15:25 Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:26 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:26 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:26 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:26 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:26 — with GitHub Actions Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to vizro_ai_secrets May 13, 2024 15:27 Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to vizro_ai_secrets May 13, 2024 15:27 Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to vizro_ai_secrets May 13, 2024 15:27 Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to vizro_ai_secrets May 13, 2024 15:27 Inactive
@pre-commit-ci pre-commit-ci bot temporarily deployed to vizro_ai_secrets May 13, 2024 15:27 Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:51 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:51 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:51 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:51 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 13, 2024 15:51 — with GitHub Actions Inactive
@antonymilne antonymilne requested a review from Anna-Xiong as a code owner May 13, 2024 16:06
@stichbury
Copy link
Contributor

The INCITS link has gone! I found one on the NIST website https://nvlpubs.nist.gov/nistpubs/ir/2021/NIST.IR.8366.pdf but I think we'll follow Google as a more accessible standard.

@stichbury stichbury temporarily deployed to vizro_ai_secrets May 13, 2024 16:44 — with GitHub Actions Inactive
@stichbury stichbury temporarily deployed to vizro_ai_secrets May 13, 2024 16:44 — with GitHub Actions Inactive
@stichbury stichbury temporarily deployed to vizro_ai_secrets May 13, 2024 16:44 — with GitHub Actions Inactive
@stichbury stichbury temporarily deployed to vizro_ai_secrets May 13, 2024 16:44 — with GitHub Actions Inactive
@stichbury stichbury temporarily deployed to vizro_ai_secrets May 13, 2024 16:44 — with GitHub Actions Inactive
@stichbury
Copy link
Contributor

Added a commit with a link that works, to replace the one broken within the docs style guidelines.

Copy link
Contributor

@petar-qb petar-qb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 14, 2024 08:00 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 14, 2024 08:00 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 14, 2024 08:00 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 14, 2024 08:00 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 14, 2024 08:00 — with GitHub Actions Inactive
@antonymilne antonymilne enabled auto-merge (squash) May 14, 2024 08:00
@antonymilne antonymilne requested a review from lingyielia as a code owner May 14, 2024 11:10
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 14, 2024 11:10 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 14, 2024 11:10 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 14, 2024 11:10 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 14, 2024 11:10 — with GitHub Actions Inactive
@antonymilne antonymilne temporarily deployed to vizro_ai_secrets May 14, 2024 11:10 — with GitHub Actions Inactive
@antonymilne antonymilne merged commit 2c3e94c into main May 14, 2024
35 of 40 checks passed
@antonymilne antonymilne deleted the docs/add-link-checker branch May 14, 2024 11:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants