chore(docs): add spellcheck (#2466)

Author: rokroskar

CHANGES.rst

@@ -47,6 +47,7 @@
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
+    "sphinxcontrib.spelling",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -95,7 +96,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ["_build"]
+exclude_patterns = ["_build", "CHANGES.rst"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

docs/conf.py

@@ -0,0 +1,251 @@
+acyclic
+admin
+Amalthea
+analytics
+api
+app
+args
+argv
+async
+attrs
+auditability
+auth
+autocomplete
+autosave
+autosaved
+backend
+backends
+backgroundImage
+balancer
+Bergstrom
+Bioconductor
+Bitnami
+blog
+BMP
+bugfix
+Calamus
+chartpress
+Chartpress
+checksum
+checksums
+ci
+CI
+circumventable
+cli
+CLI
+conda
+config
+contentMd
+cookiecutter
+Cookiecutter
+coopetition
+CountFlights
+cronjob
+Cuda
+customizable
+cwl
+CWL
+dataset
+datasets
+dataverse
+Dataverse
+deployer
+deserialization
+deserialize
+Deserialize
+discoverable
+Dockerfile
+dockerfiles
+Dockerfiles
+dockerhub
+dockerignore
+dotfiles
+Dropbox
+dropdown
+entrypoint
+executables
+extraEnv
+extraEnvFrom
+filesystem
+FilterFlights
+findable
+Fortran
+gapped
+git-lfs
+github
+gitignore
+gitkeep
+gitlab
+GitLab
+gitlabClientSecret
+GraphQL
+Homebrew
+hostname
+https
+hyperkit
+hypervisor
+iframes
+indices
+Indices
+init
+installable
+interoperability
+io
+ipynb
+iteratively
+ize
+izing
+Janusgraph
+Jena
+JPEG
+json
+jsonld
+jupyter
+Jupyterhub
+JupyterHub
+jupyterlab
+JupyterLab
+kb
+keycloak
+Keycloak
+ku
+kubernetes
+kus
+ld
+lefthand
+lfs
+localhost
+Matlab
+metadata
+microservices
+middleware
+migrationscheck
+minikube
+minimalistic
+mistyped
+mydomain
+namespace
+namespaces
+Nginx
+nodejs
+oauth
+OAuth
+oid
+ok
+online
+OpenID
+openssl
+papermill
+parameterizable
+parametrization
+parametrize
+parametrized
+pipenv
+PNG
+Postgresql
+powerline
+pre
+prepend
+preprocessed
+preprocessing
+programmatically
+py
+pyshacl
+rdflib
+readme
+rebase
+redirections
+refactor
+Refactor
+refactored
+Renga
+renku
+Renku
+renkulab
+renv
+repo
+reproducibility
+Reproducibility
+reproducibly
+resync
+reusability
+Reusability
+righthand
+roadmap
+Roadmap
+rstudio
+RStudio
+runnable
+runtime
+runtimes
+scala
+shacl
+SPARQL
+spawner
+SQLAlchemy
+statefulset
+statuspage
+stderr
+stdin
+stdout
+subclass
+Subclass
+subclasses
+Subclasses
+subcommand
+subdirectories
+subdirectory
+subgraph
+Subgraph
+submodule
+submodules
+subpath
+substep
+substeps
+sudo
+supertype
+supertypes
+symlink
+symlinks
+templated
+Tensorboard
+Tensorflow
+timestamp
+tinkerpop
+toolchain
+tutorialLink
+txt
+typesystem
+Ubuntu
+ui
+unhandled
+unicode
+unlink
+Unlink
+unlinking
+unmapped
+untracked
+untracked
+url
+username
+validator
+versioned
+versioning
+Versioning
+vertices
+vm
+webhook
+webhooks
+whitespace
+wildcard
+workflow
+Workflow
+workflows
+Workflows
+worktree
+worktree
+worktrees
+yaml
+yml
+Zenodo
+連句

docs/spelling_wordlist.txt

@@ -118,7 +118,7 @@
    :width: 850
    :alt: Iterate Plans
 
-For executing a Plan with different parameterization ``renku workflow iterate``
+For executing a Plan with different parametrization ``renku workflow iterate``
 could be used. This sub-command is basically conducting a 'grid search'-like
 execution of a Plan, with parameter-sets provided by the user.
 

renku/cli/workflow.py

@@ -15,7 +15,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-"""Resolution of Worklow execution values precedence."""
+"""Resolution of ``Workflow`` execution values precedence."""
 
 from abc import ABC, abstractmethod
 from itertools import chain

renku/core/management/workflow/value_resolution.py

@@ -46,6 +46,7 @@ check_styles(){
 
 build_docs(){
     sphinx-build -qnNW docs docs/_build/html
+    sphinx-build -nNW -b spelling -d docs/_build/doctrees docs docs/_build/spelling
     pytest -v -m "not integration and not publish" -o testpaths="docs conftest.py" --ignore=docs/conf.py
 }
 

run-tests.sh

@@ -133,7 +133,12 @@ def run(self):
 
 
 extras_require = {
-    "docs": ["Jinja2>=2.11.3,<3.0.2", "renku-sphinx-theme>=0.2.0", "sphinx-rtd-theme>=0.5.0,<1.1"],
+    "docs": [
+        "Jinja2>=2.11.3,<3.0.2",
+        "renku-sphinx-theme>=0.2.0",
+        "sphinx-rtd-theme>=0.5.0,<1.1",
+        "sphinxcontrib-spelling==7.*"
+    ],
     "runner": ["cwlref-runner==1.0"],
     "notebook": [],
     "tests": tests_require,