Update documents for oneDPL golden release

Signed-off-by: gejin <[email protected]>

documentation/library_guide/Makefile

@@ -0,0 +1,35 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = ./
+BUILDDIR      = _build
+
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ERROROPTS       = -W --keep-going
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile create_rst_examples
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+latex:
+	"$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) 
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	"(use \`make latexpdf' here to do that automatically)."
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

documentation/library_guide/_static/custom.css

@@ -0,0 +1,48 @@
+.wy-side-nav-search, .wy-nav-top {
+    background: #4308E5;
+}
+
+/* make the page width fill the window */
+.wy-nav-content {
+   max-width: 1100px;
+}
+
+
+.eqno {
+    margin-left: 5px;
+    float: right;
+}
+.math .headerlink {
+    display: none;
+    visibility: hidden;
+}
+.math:hover .headerlink {
+    display: inline-block;
+    visibility: visible;
+    margin-right: -0.7em;
+}
+
+/* A workaround for https://github.com/readthedocs/sphinx_rtd_theme/issues/647
+ * Override display for function signatures so that there is spacing between
+ * types and arguments */
+.rst-content dl:not(.docutils) dt {
+    display: table-cell !important;
+}
+.rst-content dl:not(.docutils) dd {
+    margin-top: 6px;
+}
+
+/* override table width restrictions
+ * https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html */
+@media screen and (min-width: 767px) {
+
+   .wy-table-responsive table td {
+      /* !important prevents the common CSS stylesheets from overriding
+         this as on RTD they are loaded after this stylesheet */
+      white-space: normal !important;
+   }
+
+   .wy-table-responsive {
+      overflow: visible !important;
+   }
+}

documentation/library_guide/_static/custom.js

@@ -0,0 +1,53 @@
+//configure tms    
+var wapLocalCode = 'us-en'; 
+//dynamically set per localized site, see mapping table for values    
+var wapSection = "oneapi-docs";     
+//load tms    
+(function() {                 
+    var host = (window.document.location.protocol == 'http:') ? "http://www.intel.com" : "https://www.intel.com";
+    var url = host+"/content/dam/www/global/wap/tms-loader.js"; //wap file url
+    var po = document.createElement('script'); 
+    po.type = 'text/javascript'; 
+    po.async = true;  
+    po.src = url;                 
+    var s = document.getElementsByTagName('script')[0]; 
+    s.parentNode.insertBefore(po, s);     
+})(); 
+
+window.MathJax = {
+    TeX: {
+    Macros: {
+        src: '\\operatorname{src}',
+        srclayer: '\\operatorname{src\\_layer}',
+        srciter: '\\operatorname{src\\_iter}',
+        srciterc: '\\operatorname{src\\_iter\\_c}',
+        weights: '\\operatorname{weights}',
+        weightslayer: '\\operatorname{weights\\_layer}',
+        weightsiter: '\\operatorname{weights\\_iter}',
+        weightspeephole: '\\operatorname{weights\\_peephole}',
+        weightsprojection: '\\operatorname{weights\\_projection}',
+        bias: '\\operatorname{bias}',
+        dst: '\\operatorname{dst}',
+        dstlayer: '\\operatorname{dst\\_layer}',
+        dstiter: '\\operatorname{dst\\_iter}',
+        dstiterc: '\\operatorname{dst\\_iter\\_c}',
+        diffsrc: '\\operatorname{diff\\_src}',
+        diffsrclayer: '\\operatorname{diff\\_src\\_layer}',
+        diffsrciter: '\\operatorname{diff\\_src\\_iter}',
+        diffsrciterc: '\\operatorname{diff\\_src\\_iter\\_c}',
+        diffweights: '\\operatorname{diff\\_weights}',
+        diffweightslayer: '\\operatorname{diff\\_weights\\_layer}',
+        diffweightsiter: '\\operatorname{diff\\_weights\\_iter}',
+        diffweightspeephole: '\\operatorname{diff\\_weights\\_peephole}',
+        diffweightsprojection: '\\operatorname{diff\\_weights\\_projection}',
+        diffbias: '\\operatorname{diff\\_bias}',
+        diffdst: '\\operatorname{diff\\_dst}',
+        diffdstlayer: '\\operatorname{diff\\_dst\\_layer}',
+        diffdstiter: '\\operatorname{diff\\_dst\\_iter}',
+        diffdstiterc: '\\operatorname{diff\\_dst\\_iter\\_c}',
+        diffgamma: '\\operatorname{diff\\_\\gamma}',
+        diffbeta: '\\operatorname{diff\\_\\beta}',
+        workspace: '\\operatorname{workspace}'
+    }
+    }
+}

documentation/library_guide/_templates/layout.html

@@ -0,0 +1,33 @@
+{% extends "!layout.html" %}
+
+          {% block sidebartitle %}
+
+          {% if logo and theme_logo_only %}
+            <a href="{{ pathto(master_doc) }}">
+          {% else %}
+            <a href="https://docs.oneapi.com/index.html" class="icon icon-home"> {{ project }}
+          {% endif %}
+
+          {% if logo %}
+            {# Not strictly valid HTML, but it's the only way to display/scale
+               it properly, without weird scripting or heaps of work
+            #}
+            <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="Logo"/>
+          {% endif %}
+          </a>
+
+          {% if theme_display_version %}
+            {%- set nav_version = version %}
+            {% if READTHEDOCS and current_version %}
+              {%- set nav_version = current_version %}
+            {% endif %}
+            {% if nav_version %}
+              <div class="version">
+                {{ nav_version }}
+              </div>
+            {% endif %}
+          {% endif %}
+
+          {% include "searchbox.html" %}
+
+          {% endblock %}

documentation/library_guide/conf.py

@@ -0,0 +1,153 @@
+#===============================================================================
+# Copyright 2014-2020 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# 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.
+#===============================================================================
+
+##  Content:
+##     Intel(R) DAAL configuration file for the Sphinx documentation builder
+##******************************************************************************
+
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'oneAPI Libraries Documentation'
+copyright = '2020, Intel Corporation'
+author = 'Intel'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0'
+
+rst_prolog = """
+.. |full_name| replace::  oneAPI Libraries
+.. |short_name| replace:: oneAPI
+.. |product| replace:: prod
+.. |namespace| replace:: namespace
+.. |daal_in_code| replace:: in_code
+.. |reg| unicode:: U+000AE
+.. |copy| unicode:: U+000A9
+.. |base_tk| replace:: Intel\ |reg|\  oneAPI Base Toolkit
+.. |dpcpp| replace:: Intel\ |reg|\  oneAPI DPC++ Compiler
+"""
+
+
+# for substitutions in code blocks and sphinx-prompts:
+substitutions = [
+    ('|short_name|', 'oneDAL'),
+    ('|daal_in_code|', 'daal')
+    ]
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx-prompt', 
+    'sphinx_substitution_extensions', 
+    #'sphinx.ext.extlinks', 
+    #'sphinx_tabs.tabs'
+	]
+
+docbundle_settings = {
+    'csv_dir':'csv_dir'
+}
+
+
+# The master toctree document.
+master_doc = 'index'
+
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["opt-notice.rst", 'dev_guide/data-management/numeric-tables/*.rst', 'topics/*.rst',
+                    'dev_guide/algorithms/dbscan/distributed-steps/*',
+                    'dev_guide/algorithms/kmeans/includes/*',
+                    'notes/issues/2021.1-beta06/includes/*']
+
+extlinks = {'cpp_example': ('https://github.com/oneapi-src/oneDAL/tree/master/examples/cpp/source/%s', ''),
+'java_example': ('https://github.com/oneapi-src/oneDAL/tree/master/examples/java/com/intel/daal/examples/%s', ''),
+'daal4py_example': ('https://github.com/IntelPython/daal4py/tree/master/examples/%s', ''),
+'cpp_sample': ('https://github.com/oneapi-src/oneDAL/tree/master/samples/cpp/%s', '')}
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+## html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+html_css_files = [
+    'custom.css',
+]
+html_logo = '_static/oneAPI-rgb-rev-100.png'
+html_favicon = '_static/favicons.png'
+#latex_logo = '_static/oneAPI-rgb-3000.png'
+html_show_sourcelink = False
+#html_js_files = ['custom.js']
+
+# html_context = {
+#     'css_files': [
+#         '_static/style.css',  # override wide tables in RTD theme
+#         ],
+#     }
+
+
+# html_theme = 'otc_tcs_sphinx_theme'
+# html_theme_path = ['_themes']
+
+import sys
+import os
+# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+import sphinx_rtd_theme
+html_theme = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+if on_rtd:
+    using_rtd_theme = True
+
+# Theme options
+html_theme_options = {
+    # 'typekit_id': 'hiw1hhg',
+    # 'analytics_id': '',
+    # 'sticky_navigation': True,  # Set to False to disable the sticky nav while scrolling.
+    'logo_only': False,  # if we have a html_logo below, this shows /only/ the logo with no title text
+    'collapse_navigation': False,  # Collapse navigation (False makes it tree-like)
+    # 'display_version': True,  # Display the docs version
+    'navigation_depth': 4  # Depth of the headers shown in the navigation bar
+}

documentation/library_guide/extension_api.rst

@@ -243,13 +243,13 @@ lesser argument unchanged.
 - maximum: A function object type where the operator() applies ``std::greater`` to its arguments, then returns the
 greater argument unchanged.
 
-
 Range-based API
 --------------------------
 
 C++20 indroduces the *Ranges* library. С++20 standard splits ranges into two categories: *factories* and *adaptors*.
 A range factory doesn't have underlying data. An element is generated on success by an index or by dereferencing an iterator.
-A range adaptor, from the DPC++ library perspective, is an utility that transforms *base range*, or another adapted range into a view with custom behavior.
+A range adaptor, from the DPC++ library perspective, is an utility that transforms *base range*, or another adapted range into 
+a view with custom behavior.
 
 The DPC++ library supports ``iota_view`` range factory.
 
@@ -264,7 +264,8 @@ The range adaptors may be combined into a pipeline with a ``base`` range at the
     auto range_1 = iota_view(0, 10) | views::reverse();
     auto range_2 = all_view(buf) | views::reverse();
 
-For the range, based on the ``all_view`` factory, data access is permitted on a device only. ``size()`` and ``empty()`` methods are allowed to be called on both host and device.
+For the range, based on the ``all_view`` factory, data access is permitted on a device only. ``size()`` and ``empty()`` methods are allowed 
+to be called on both host and device.
 
 The following algorithms are available to use with the ranges:
 

documentation/library_guide/index.rst

@@ -0,0 +1,24 @@
+oneAPI DPC++ Library Guide
+=================================
+
+An introduction to the oneAPI DPC++ Library (oneDPL).
+
+oneDPL aims to work with the oneAPI DPC++/C++ Compiler to
+provide high-productivity APIs to developers, which can minimize Data Parallel C++ (DPC++) programming
+efforts across devices for high performance parallel applications. oneDPL contains an additional set of library classes and functions that are referred to throughout this document as **Extension API**.
+oneDPL consists of the following components:
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+   :glob:
+
+   before_you_begin
+   pstl_main
+   pstl/index
+   extension_api
+   tested_standard_cpp_api
+   random 
+   notices_disclaimers
+
+

documentation/library_guide/notices_disclaimers.rst

@@ -0,0 +1,17 @@
+Notices and Disclaimers
+=======================
+
+Intel technologies may require enabled hardware, software or service activation.
+
+No product or component can be absolutely secure.
+
+Your costs and results may vary.
+
+© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.
+
+No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document.
+
+The products described may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request.
+
+Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, or usage in trade.
+