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

Add GitHub Action for Sphinx documentation link checking #464

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

rexbrown21
Copy link

Description

  • Implemented a GitHub Action to automatically check for dead links in Sphinx-generated documentation.
  • Configured the action to trigger on push and pull request events to the main branch.
  • Ensured that the action installs necessary dependencies, including sphinx-linkcheck.
  • Verified that broken links are reported in the workflow output, failing the action if any are found.
  • Enhanced overall documentation reliability by preventing the inclusion of dead links in the project.

Contributor checklist
[X] This pull request is on a separate branch and not the main branch
[X] I have tested my code with the pytest command as directed in the testing section of the contributing guide

Copy link

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

  • The linting and formatting workflow within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

First PR Commit Check

  • The commit messages for the remote branch of a new contributor should be checked to make sure their email is set up correctly so that they receive credit for their contribution
    • The contributor's name and icon in remote commits should be the same as what appears in the PR
    • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-Data repo

@rexbrown21
Copy link
Author

I've made the changes

@andrewtavis
Copy link
Member

Hi @rexbrown21 👋 Could you take a look into the workflow and see why the dependencies aren't installed?

@rexbrown21
Copy link
Author

I'm on it!

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.

2 participants