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

Problem: there is no spellchecking #1688

Open
3 tasks
eviau-artefactual opened this issue May 8, 2024 · 2 comments
Open
3 tasks

Problem: there is no spellchecking #1688

eviau-artefactual opened this issue May 8, 2024 · 2 comments

Comments

@eviau-artefactual
Copy link

Version of the documentation

1.16 and before

Page (and section, if applicable) where the issue occurs

The documentation in general.

Description of the issue

There is not spellchecking that is set up for the documentation.

Suggested fix

Enable spellchecking through GitHub Actions and a relevant Sphinx extension.


For Artefactual use:

Before you close this issue, you must check off the following:

  • All pull requests related to this issue are properly linked
  • All pull requests related to this issue have been merged
  • Details about this issue have been added to the release notes (if applicable)
@eviau-artefactual
Copy link
Author

Suggestion for a sphinx extension: https://sphinxcontrib-spelling.readthedocs.io - the previous PRs make use of it.

@eviau-artefactual
Copy link
Author

For the record: this is more or less the same process as in artefactual/atom-docs#257

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

No branches or pull requests

1 participant