automatic spellcheck by codespell for common misspellings.

[fujitatomoya]

follow-up of #4980.

[github-actions]

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/13183844552/artifacts/2548931443.

To view the resulting site:

1. Click on the above link to download the artifacts archive
2. Extract it
3. Open html-artifacts-4997/index.html in your favorite browser

[fujitatomoya]

some important notes related to this PR.

• This PR enables codespell check for both make spellcheck in local environment and github action.
• --skip="source/Releases/*": this folder is ignored because of a couple of reasons. 1st xxx-Changelog.rst is basically generated by commit log that could include the some misspelling, but i think we should keep the original commit messages here. 2nd, that includes names for authors and contributors, that compiles up the false alarms.

rosindex@3a0a0abcf2df:/tmp/doc_repository$ git ls-files '*.md' '*.rst' | xargs codespell --ignore-words=codespell_whitelist.txt 
source/Releases/Beta3-Overview.rst:29: Readded ==> Re-added, Read
source/Releases/Galactic-Geochelone-Complete-Changelog.rst:738: explictly ==> explicitly
source/Releases/Galactic-Geochelone-Complete-Changelog.rst:768: arbitraty ==> arbitrary
source/Releases/Galactic-Geochelone-Complete-Changelog.rst:775: Servin ==> Serving
source/Releases/Galactic-Geochelone-Complete-Changelog.rst:775: Idel ==> Idle
source/Releases/Galactic-Geochelone-Complete-Changelog.rst:804: dependancy ==> dependency
source/Releases/Galactic-Geochelone-Complete-Changelog.rst:833: Idel ==> Idle
source/Releases/Galactic-Geochelone-Complete-Changelog.rst:909: paramter ==> parameter
source/Releases/Galactic-Geochelone-Complete-Changelog.rst:1323: Servin ==> Serving
source/Releases/Galactic-Geochelone-Complete-Changelog.rst:1323: Idel ==> Idle
...

• since address mistyping detected by codespell checker. #4980 (and jazzy and humble backports) has already merged, there should be no misspelling warning, that means we can run the spell check for entire repository. (we could run the spelling check for only changed part, but i do not think that is really needed.)
• execution time is reasonably fast enough even running for all markdown and rst files.

rosindex@3a0a0abcf2df:/tmp/doc_repository$ time make spellcheck
git ls-files '*.md' '*.rst' | xargs codespell --ignore-words=codespell_whitelist.txt --skip="source/Releases/*"

real    0m0.210s
user    0m0.202s
sys     0m0.008s

• Permissive common misspelling only. according to codespell-project, it tells that It does not check for word membership in a complete dictionary, but instead looks for a set of common misspellings. that said we can start small without false alarms, at least address mistyping detected by codespell checker. #4980 related misspelling can be detected via github action before merge.

i had tried some test for failure case,

it can tells where and how exactly it should be fixed.

[fujitatomoya]

@kscottz @christophebedard @clalancette i think this is solid and ready to fly 🤔 compared to once-sentence-per-line rule. would love to get feedback on this.

[kscottz]

@fujitatomoya you are the absolute best and this looks good to go for now.

Looking at the Code Spell docs it appears they support a custom dictionary. It seems like we could add a custom dictionary to catch some common stuff like "ROS2 -> ROS 2", etc.

[fujitatomoya]

@kscottz

catch some common stuff like "ROS2 -> ROS 2", etc.

actually this is really good idea. after this PR is merged, i will open the issue to brainstorm the ROS 2 doc dictionary👍

[fujitatomoya]

@clalancette @kscottz @christophebedard thanks for the review, permissive spell check is now online for all distros!

as Kat suggested above, ROS 2 dictionary approach can be good without having false alarms. i will look into that feature, and create the issue for that.

[ros-discourse]

This pull request has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/requesting-help-lets-make-ros-2-dictionary-for-spell-checker/42005/1