Using sphinxcontrib.spelling as extension (#1800)

* 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

Author: antonwolfy

.github/workflows/build-sphinx.yml

@@ -77,6 +77,11 @@ jobs:
                                intel-oneapi-mkl-devel          \
                                intel-oneapi-compiler-dpcpp-cpp
 
+      # required by sphinxcontrib-spelling extension
+      - name: Install enchant package
+        run: |
+          sudo apt-get install enchant-2
+
       # https://github.com/marketplace/actions/checkout
       - name: Install nvidia-cuda support drivers
         run: |
@@ -103,7 +108,8 @@ jobs:
       - name: Install sphinx dependencies
         run: |
           conda install sphinx sphinx_rtd_theme
-          pip install sphinxcontrib-googleanalytics==0.4
+          pip install sphinxcontrib-googleanalytics==0.4 \
+            pyenchant sphinxcontrib-spelling
 
       - name: Install dpnp dependencies
         run: |
@@ -122,6 +128,10 @@ jobs:
       - name: Build library
         run: python scripts/build_locally.py
 
+      - name: Run a spelling checker for docs
+        run: make spelling
+        working-directory: doc
+
       - name: Build docs
         run: make html
         working-directory: doc

doc/conf.py

@@ -59,11 +59,18 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinxcontrib.googleanalytics",
+    "sphinxcontrib.spelling",
 ]
 
 googleanalytics_id = "G-554F8VNE28"
 googleanalytics_enabled = True
 
+# Enable a misspelling as a sphinx warning
+spelling_warning = True
+
+# Define a list of words known to be spelled correctly
+spelling_word_list_filename = "known_words.txt"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

doc/known_words.txt

@@ -0,0 +1,68 @@
+backend
+bitwise
+boolean
+broadcastable
+broadcasted
+byteorder
+Cholesky
+conda
+Decompositions
+dimensionality
+docstring
+dpctl
+dpnp
+dtype
+dtypes
+einsum
+endian
+eps
+epsneg
+Extrema
+finfo
+finiteness
+Fortran
+Frobenius
+Hypergeometric
+iinfo
+Infs
+iterable
+Lomax
+Mersenne
+meshgrid
+Mises
+multinomial
+NaN
+NaT
+ndarray
+ndarrays
+ndim
+normed
+oneAPI
+orthonormal
+Penrose
+Polyutils
+prepend
+prepending
+representable
+runtimes
+scikit
+signbit
+signum
+subarray
+subarrays
+subclasses
+subtype
+SyclDevice
+SyclQueue
+th
+ufunc
+ufuncs
+Unary
+unicode
+usm
+Vandermonde
+vectorized
+von
+Weibull
+whitespace
+Zipf

doc/quick_start_guide.rst

@@ -71,7 +71,7 @@ And to build dpnp package from the sources:
 
     conda build conda-recipe -c intel -c conda-forge
 
-Finanly, to install the result package:
+Finally, to install the result package:
 
 .. code-block:: bash
 

doc/reference/binary.rst

@@ -3,7 +3,7 @@ Binary Operations
 
 .. https://docs.scipy.org/doc/numpy/reference/routines.bitwise.html
 
-Elementwise bit operations
+Element-wise bit operations
 --------------------------
 
 .. autosummary::

doc/reference/ndarray.rst

@@ -231,9 +231,9 @@ Each of the arithmetic operations (``+``, ``-``, ``*``, ``/``, ``//``,
 ``%``, ``divmod()``, ``**`` or ``pow()``, ``<<``, ``>>``, ``&``,
 ``^``, ``|``, ``~``) and the comparisons (``==``, ``<``, ``>``,
 ``<=``, ``>=``, ``!=``) is equivalent to the corresponding
-universal function (or **ufunc** for short) in DPNP.  For
+universal function (or :term:`ufunc` for short) in DPNP. For
 more information, see the section on :ref:`Universal Functions
-<ufunc>`.
+<ufuncs>`.
 
 
 Comparison operators:
@@ -249,6 +249,23 @@ Comparison operators:
    dpnp.ndarray.__eq__
    dpnp.ndarray.__ne__
 
+Truth value of an array (:func:`bool()`):
+
+.. autosummary::
+   :toctree: generated/
+
+   dpnp.ndarray.__bool__
+
+.. note::
+
+   Truth-value testing of an array invokes
+   :meth:`dpnp.ndarray.__bool__`, which raises an error if the number of
+   elements in the array is larger than 1, because the truth value
+   of such arrays is ambiguous. Use :meth:`.any() <dpnp.ndarray.any>` and
+   :meth:`.all() <dpnp.ndarray.all>` instead to be clear about what is meant
+   in such cases. (If the number of elements is 0, the array evaluates
+   to ``False``.)
+
 
 Unary operations:
 
@@ -303,6 +320,14 @@ Arithmetic, in-place:
    dpnp.ndarray.__ixor__
 
 
+Matrix Multiplication:
+
+.. autosummary::
+   :toctree: generated/
+
+   dpnp.ndarray.__matmul__
+
+
 Special methods
 ---------------
 

doc/reference/ufunc.rst

@@ -5,7 +5,7 @@ Universal Functions (ufunc)
 
 .. https://docs.scipy.org/doc/numpy/reference/ufuncs.html
 
-DPNP provides universal functions (a.k.a. ufuncs) to support various elementwise operations.
+DPNP provides universal functions (a.k.a. ufuncs) to support various element-wise operations.
 
 Available ufuncs
 ----------------

dpnp/dparray.pyx

@@ -1064,7 +1064,7 @@ cdef class dparray:
         Limitations
         -----------
         Input array is supported as :obj:`dpnp.ndarray`.
-        Input kth is supported as :obj:`int`.
+        Input `kth` is supported as :obj:`int`.
         Parameters `axis`, `kind` and `order` are supported only with default values.
 
         """