Full names include oneAPI, add spellchecker (#89)

.github/workflows/main.yml

@@ -21,3 +21,8 @@ jobs:
       with:
           name: oneapi-spec-artifacts
           path: site.zip
+    - name: Archive spellcheck
+      uses: actions/upload-artifact@v1
+      with:
+          name: spell check
+          path: build/spelling/output.txt

requirements.txt

@@ -11,4 +11,5 @@ sphinx-rtd-theme
 sphinx-prompt
 sphinx_substitution_extensions
 sphinx_tabs
+sphinxcontrib-spelling
 graphviz

scripts/install.sh

@@ -46,6 +46,7 @@ make install
 set -e
 popd
 apt-get install -y \
+                    enchant \
                     graphviz \
                     latexmk \
                     texlive-latex-base \

scripts/oneapi.py

@@ -332,6 +332,7 @@ def ci(root, target=None):
     root_only(root)
     get_tarballs(root)
     site(root)
+    build('.', 'spelling')
     if args.branch == 'publish' or args.branch == 'refs/heads/publish':
         stage_publish(root)
     else:
@@ -348,6 +349,7 @@ def ci(root, target=None):
             'dockerrun': dockerrun,
             'html': build,
             'latexpdf': build,
+            'spelling': build,
             'prep': prep,
             'prod-publish': prod_publish,
             'purge': purge,
@@ -370,7 +372,7 @@ def ci(root, target=None):
 def main():
     global args
     parser = argparse.ArgumentParser(description='Build oneapi spec.')
-    parser.add_argument('action',choices=commands.keys())
+    parser.add_argument('action',choices=commands.keys(), default='html', nargs='?')
     parser.add_argument('root', nargs='?', default='.')
     parser.add_argument('--branch')
     parser.add_argument('--dry-run', action='store_true')

source/conf/common_conf.py

@@ -2,30 +2,30 @@
     'notfound.extension',
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
-#    'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
     'sphinx.ext.graphviz',
+    'sphinxcontrib.spelling',
     'sphinx_substitution_extensions',
     'breathe',
 ]
 
 rst_prolog = """
-.. |ccl_full_name| replace:: Collective Communications Library
-.. |dal_full_name| replace:: Data Analytics Library
+.. |ccl_full_name| replace:: oneAPI Collective Communications Library
+.. |dal_full_name| replace:: oneAPI Data Analytics Library
 .. |dal_short_name| replace:: oneDAL
 .. |dal_namespace| replace:: daal
-.. |dnn_full_name| replace:: Deep Neural Network Library
-.. |dpl_full_name| replace:: DPC++ Library
+.. |dnn_full_name| replace:: oneAPI Deep Neural Network Library
+.. |dpl_full_name| replace:: oneAPI DPC++ Library
 .. |dpcpp_full_name| replace:: DPC++
-.. |l0_full_name| replace:: Level Zero
-.. |mkl_full_name| replace:: Math Kernel Library
-.. |tbb_full_name| replace:: Threading Building Blocks
-.. |vpl_full_name| replace:: Video Processing Library
+.. |l0_full_name| replace:: oneAPI Level Zero
+.. |mkl_full_name| replace:: oneAPI Math Kernel Library
+.. |tbb_full_name| replace:: oneAPI Threading Building Blocks
+.. |vpl_full_name| replace:: oneAPI Video Processing Library
 """
 
 # for substitutions in code blocks and sphinx-prompts:

source/elements/oneCCL/source/spec/collective_communication.rst

@@ -1,7 +1,7 @@
 oneCCL Collective Communication
 ===============================
 
-Thi section covers collective communcation operations implemented in |ccl_full_name|.
+This section covers collective communication operations implemented in |ccl_full_name|.
 
 .. toctree::
    :maxdepth: 1

source/elements/oneVPL/source/VPL_workstreams.rst

@@ -11,7 +11,7 @@ There are four subclasses of :class:`vpl::Workstream` that perform the following
 - :class:`vpl::Encode`: encode raw frames to a bitstream 
 
 In the :class:`vpl::VideoProcess` subclass, a sequence of filters with single input and single output running on the same device context can be fused to the same workstream. 
-Operations executing on different device contexts are seperated to different worksteams such that each workstream can be dispatched to a single device context. 
+Operations executing on different device contexts are separated to different worksteams such that each workstream can be dispatched to a single device context. 
 
 Workstream Internals
 --------------------

source/elements/oneVPL/source/index.rst

@@ -66,7 +66,7 @@ Encode
 ------
 .. include:: VPL_encode.rst
 
-Vidoe Processing
+Video Processing
 ----------------
 .. include:: VPL_processframe.rst