Using sphinxcontrib.spelling as extension #1800
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
antonwolfy
force-pushed
the
add-sphinxcontrib.spelling-as-extension
branch
from
a3beac3 to
1edaf7c
Compare
|
View rendered docs @ https://intelpython.github.io/dpnp/index.html |
antonwolfy
force-pushed
the
add-sphinxcontrib.spelling-as-extension
branch
from
632083d to
12df230
Compare
vlad-perevezentsev
approved these changes
Apr 29, 2024
github-actions bot
added a commit
that referenced
this pull request
Apr 29, 2024
* Using sphinxcontrib.spelling as extension * Installing enchant package required by sphinxcontrib-spelling * Run a spelling checker for docs * Installing pyenchant package * Aligned docstrings of elementwise functions with dpctl.tensor * Aligned docstrings of returns in elementwise functions with dpctl.tensor * Install enchant apt package * Extend dictionary with dpnp, dtype, ndarray, ufunc and ufuncs words * Fixed spelling issues and added 15 new words to known list * Fixed spelling issues and added 7 new words to known list * Fixed spelling issues and added 15 new words to known list * Fixed spelling issues and added 10 new words to known list * Fixed spelling issues and added 4 new words to known list * Fixed spelling issues and added 7 new words to known list * Added missing docstrings to ndarray methods * Fixed building issue in ndarray.rst * Resolved a warning: term not in glossary: 'universal function' * Resolve a warning after rebase with master c348bf4
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The PR enables sphinx extension for spelling checks of the generated documentation.
The spelling check is added to a separated step
Run a spelling checker for docsfor the appropriate GH action where the documentation is generating.All detected warnings are resolved or the default spelling dictionary is expanded with new known words.
Note, a manual check that no further warnings are entered is expected by every next PR.