Skip to content

Documentation: Implement automatic spelling check #77

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

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

Conversation

activus-d
Copy link
Collaborator

This PR solves issue #76 by implementing an automatic spell checking for the documentation using pyspelling instead of sphinxcontrib.spelling.

Changes Introduced

  • Updated the docs/Makefile to include:
    • Automated installation of aspell and pyspelling across common operating systems.
    • make run now builds and serves docs, and runs the spelling check.
  • Created spellingcheck.yaml: Configures pyspelling to check built HTML files, excluding pages like glossary, index, and style guide.
  • Added docs/wordlist.txt, a custom dictionary of valid project-specific terms.
  • Updated pyproject.toml to include pyspelling as a documentation dependency.
  • Added .gitignore rules to exclude docs/wordlist.dic.
  • Improved contributing/index.rst:
    • Linked to repo on the first mention
    • Reworded instructions for serving and watching docs.

Copy link

codecov bot commented Jul 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.0%. Comparing base (5b05c2f) to head (eb430f1).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #77   +/-   ##
=======================================
  Coverage   100.0%   100.0%           
=======================================
  Files          13       13           
  Lines         748      748           
  Branches       63       63           
=======================================
  Hits          748      748           

☔ View full report in Codecov by Sentry.
📢 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.

@activus-d activus-d requested a review from Stormheg July 15, 2025 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant