Skip to content

ci: check README documentation links#952

Open
wenxiaojie1 wants to merge 1 commit into
ev-flow:masterfrom
wenxiaojie1:ci-check-readme-doc-links
Open

ci: check README documentation links#952
wenxiaojie1 wants to merge 1 commit into
ev-flow:masterfrom
wenxiaojie1:ci-check-readme-doc-links

Conversation

@wenxiaojie1

Copy link
Copy Markdown
Contributor

Summary

  • add a standalone README documentation-link validator
  • check that each local Read the Docs page and anchor exists after the docs build
  • run the validator in a dedicated GitHub Actions workflow

Validation

  • python -m unittest discover -s docs/tests
  • sphinx-build docs/source docs/_build/html
  • python docs/check_readme_links.py

@codecov

codecov Bot commented Jul 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.27%. Comparing base (108394f) to head (75e5ba8).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #952   +/-   ##
=======================================
  Coverage   80.27%   80.27%           
=======================================
  Files          82       82           
  Lines        7185     7185           
=======================================
  Hits         5768     5768           
  Misses       1417     1417           
Flag Coverage Δ
unittests 80.27% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@haeter525

Copy link
Copy Markdown
Member

Thanks for helping add the checks!
Hi @pulorsok could you help take a look when you have a moment?

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