IntelPython · samaid · Nov 17, 2022 · Nov 16, 2022 · Nov 17, 2022
diff --git a/README.md b/README.md
@@ -1,9 +1,15 @@
-# DPPY
+# Data Parallel Extensions for Python*
 
-## Documnetation
+Data Parallel Extensions for Python* extend numerical Python capabilities beyond CPU and allow even higher performance 
+gains on data parallel devices such as GPUs. It consists of three related projects:
+* [**dpnp** – Data Parallel Extensions for Numpy*](https://github.com/IntelPython/dpnp) - a library that implements a subset 
+             of Numpy that can be executed on any data parallel device. The subset is a drop-in replacement of core 
+             Numpy functions and numerical data types. 
+* [**numba-dpex** – Data Parallel Extensions for Numba*](https://github.com/IntelPython/numba-dpex) - extension for Numba 
+             compiler that enables programming data parallel devices the same way you program CPU with Numba.
+* [**dpctl** – Data Parallel Control library](https://github.com/IntelPython/dpctl) that provides utilities for device 
+              selection, allocation of data on devices, tensor data structure along with Python Array API standard 
+              implementation, and support for creation of user-defined data-parallel extensions.
 
-https://intelpython.github.io/DPPY/main/
+Read more about Data Parallel Extensions for Python https://intelpython.github.io/DPPY/main/
 
-## Contributing
-
-For contributing to this repository see [CONTRIBUTING.md](CONTRIBUTING.md).
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/sources/conf.py b/docs/sources/conf.py
@@ -0,0 +1,258 @@
+""""
+# 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:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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('.'))
+
+import sphinx_rtd_theme
+
+# -- Project information -----------------------------------------------------
+
+project = "Data Parallel Extensions for Python"
+copyright = "2021, Intel"
+author = "Intel"
+
+# The full version, including alpha/beta/rc tags
+release = "0.0.1"
+
+
+# -- 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 = [
+    "recommonmark",
+    "sphinx_rtd_theme",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.todo",
+]
+
+todo_include_todos = True
+
+source_parsers = {".md": "recommonmark.parser.CommonMarkParser"}
+
+# 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 = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- 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 = "sphinx_rtd_theme"
+
+# 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"]
+"""
+
+# *****************************************************************************
+# Copyright (c) 2020, Intel Corporation All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#     Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#
+#     Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *****************************************************************************
+
+
+# coding: utf-8
+# Configuration file for the Sphinx documentation builder.
+#
+# -- 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('.'))
+
+
+# -- Import sdc package to build API Reference -------------------------------
+#import os
+#import sys
+#import shutil
+
+#SDC_DOC_NO_API_REF_STR = 'SDC_DOC_NO_API_REF'
+#SDC_DOC_APIREF_DIR = '_api_ref'
+
+#sys.path.insert(0, os.path.relpath('buildscripts'))
+#sdc_doc_no_api_ref = False  # Generate API Reference by default
+
+#if SDC_DOC_NO_API_REF_STR in os.environ:
+#    sdc_doc_no_api_ref = os.environ[SDC_DOC_NO_API_REF_STR] == '1'
+
+#if not sdc_doc_no_api_ref:
+#    if os.path.exists(SDC_DOC_APIREF_DIR):
+#        shutil.rmtree(SDC_DOC_APIREF_DIR)
+
+#    try:
+#        import sdc
+#    except ImportError:
+#        raise ImportError('Cannot import sdc.\n'
+#                          'Documentation generator for API Reference for a given module expects that module '
+#                          'to be installed. Use conda/pip install SDC to install it prior to using API Reference '
+#                          'generation. If you want to disable API Reference generation, set the environment '
+#                          'variable SDC_DOC_NO_API_REF=1')
+
+#    try:
+#        from apiref_generator import generate_api_reference
+#    except ImportError:
+#        raise ImportError('Cannot import apiref_generator', os.getcwd())
+
+#    generate_api_reference()
+
+#SDC_DOC_NO_EXAMPLES_STR = 'SDC_DOC_NO_EXAMPLES'
+#SDC_DOC_EXAMPLES_DIR = '_examples'
+
+#sdc_doc_no_examples = False  # Generate examples list by default
+#if SDC_DOC_NO_EXAMPLES_STR in os.environ:
+#    sdc_doc_no_examples = os.environ[SDC_DOC_NO_EXAMPLES_STR] == '1'
+
+#if not sdc_doc_no_examples:
+#    if os.path.exists(SDC_DOC_EXAMPLES_DIR):
+#        shutil.rmtree(SDC_DOC_EXAMPLES_DIR)
+
+#    try:
+#        import sdc
+#    except ImportError:
+#        raise ImportError('Cannot import sdc.\n'
+#                          'Documentation generator for Examples for a given module expects that module '
+#                          'to be installed. Use conda/pip install SDC to install it prior to using API Examples '
+#                          'generation. If you want to disable Examples generation, set the environment '
+#                          'variable SDC_DOC_NO_EXAMPLES_STR=1')
+
+#    try:
+#        from examples_generator import generate_examples
+#    except ImportError:
+#        raise ImportError('Cannot import examples_generator', os.getcwd())
+
+#    generate_examples()
+
+# -- Project information -----------------------------------------------------
+
+project = 'Data Parallel Extensions for Python*'
+copyright = '2022, Intel Corporation'
+author = 'Intel Corporation'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- 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.ext.todo',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.extlinks',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.napoleon',
+    'sphinxcontrib.programoutput',
+]
+
+
+# Add any paths that contain templates here, relative to this directory.
+#templates_path = ['_templates']
+templates_path = []
+
+# 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 = []
+
+
+# -- 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 = 'sdc-sphinx-theme'
+
+html_theme_path = ['.']
+
+html_theme_options = {
+}
+
+# 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 = []
+
+html_sidebars = {
+    '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html', 'relations.html'],
+}
+
+html_show_sourcelink = False
+
+# -- Todo extension configuration  ----------------------------------------------
+todo_include_todos = True
+todo_link_only = True
+
+# -- InterSphinx configuration: looks for objects in external projects -----
+# Add here external classes you want to link from Intel SDC documentation
+# Each entry of the dictionary has the following format:
+#      'class name': ('link to object.inv file for that class', None)
+#intersphinx_mapping = {
+#    'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
+#    'python': ('http://docs.python.org/2', None),
+#    'numpy': ('http://docs.scipy.org/doc/numpy', None)
+#}
+intersphinx_mapping = {
+}
+
+# -- Napoleon extension configuration (Numpy and Google docstring options) -------
+#napoleon_google_docstring = True
+#napoleon_numpy_docstring = True
+#napoleon_include_init_with_doc = True
+#napoleon_include_private_with_doc = True
+#napoleon_include_special_with_doc = True
+#napoleon_use_admonition_for_examples = False
+#napoleon_use_admonition_for_notes = False
+#napoleon_use_admonition_for_references = False
+#napoleon_use_ivar = False
+#napoleon_use_param = True
+#napoleon_use_rtype = True
+
+# -- Prepend module name to an object name or not -----------------------------------
+add_module_names = False
diff --git a/docs/index.rst → docs/sources/index.rst b/docs/index.rst → docs/sources/index.rst
diff --git a/docs/sources/sdc-sphinx-theme/globaltoc.html b/docs/sources/sdc-sphinx-theme/globaltoc.html
@@ -0,0 +1,3 @@
+<h3>Table of Contents</h3>
+{{ toctree(maxdepth=-1, titles_only=true) }}
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		<h3>Table of Contents</h3>
		{{ toctree(maxdepth=-1, titles_only=true) }}