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

CI job to catch broken links in our documentation #758

Closed
mateusoliveira43 opened this issue Jan 2, 2023 · 0 comments · Fixed by #816
Closed

CI job to catch broken links in our documentation #758

mateusoliveira43 opened this issue Jan 2, 2023 · 0 comments · Fixed by #816
Assignees
@mateusoliveira43
Labels
ci tool-sharpening Related to the tools we use for the project

Comments

@mateusoliveira43
Copy link
Collaborator

The command mkdocs serve warns about broken links or unused files, but as warning.

Check if is possible to treat them as errors and add a CI job for checking documentation, as Sphinx allows.

Example: https://github.com/mateusoliveira43/python-project-template/blob/main/scripts/dev_cli/commands/doc.py#L15-L49
@mateusoliveira43 mateusoliveira43 added the docs Documentation issue label Jan 24, 2023
@mpryc mpryc added ci tool-sharpening Related to the tools we use for the project and removed docs Documentation issue labels Jan 24, 2023
@mpryc mpryc changed the title Documentation warning CI job to catch broken links in our documentation Jan 24, 2023
@mateusoliveira43 mateusoliveira43 self-assigned this Jan 25, 2023
@mateusoliveira43 mateusoliveira43 mentioned this issue Jan 25, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mateusoliveira43 mateusoliveira43

Labels
ci tool-sharpening Related to the tools we use for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: CI job for checking documentation generation mateusoliveira43/pelorus
2 participants
@mpryc @mateusoliveira43