Changes for oneART publishing (#284)

rscohn2 · web-flow · commit 4dfabacb363c · 2021-02-10T09:37:36.000-05:00
diff --git a/oneapi-doc.json b/oneapi-doc.json
@@ -1,4 +1,5 @@
 {
     "version": "1.0-rev-2",
-    "vpl_version": "2.1.0"
+    "vpl_version": "2.1.0",
+    "art_version": "0.5-rev-1"
 }
diff --git a/source/conf.py b/source/conf.py
@@ -66,6 +66,8 @@
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = [
+    'elements/oneART/source/versions.rst',
+    'elements/oneART/source/index.rst',
     'elements/oneTBB/source/index.rst',
     'elements/oneTBB/source/uncategorized.rst',
     'elements/oneTBB/source/uncategorized/**',
diff --git a/source/conf/element_conf.py b/source/conf/element_conf.py
@@ -19,7 +19,7 @@
 
 # -- Project information -----------------------------------------------------
 
-copyright = u'2020, Intel'
+copyright = u'2021, Intel'
 author = u'Intel'
 
 # The short X.Y version
diff --git a/source/elements/oneART/source/acknowledgment.rst b/source/elements/oneART/source/acknowledgment.rst
@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. _acknowledgment-section:
+
 ==============
 Acknowledgment
 ==============
diff --git a/source/elements/oneART/source/appendices.rst b/source/elements/oneART/source/appendices.rst
@@ -6,7 +6,17 @@
 Appendices
 ==========
 
+- :ref:`ospray-studio-section`: Rendering Focused Application fully
+  utilizing the OSPRay API.
+- :ref:`ospray-hydra-plugin-section`: Universal Scene Description
+  “Hydra API Delegate” using OSPRay for scalable interactive and
+  real-time ray traced preview
+- :ref:`ispc-section`: Single Program Multi-Data Vectorizing Compiler
+- Future Considerations
+- :ref:`acknowledgment-section`
+
 .. toctree::
+   :hidden:
    :maxdepth: 1
 
    ospray-studio
diff --git a/source/elements/oneART/source/component-libraries.rst b/source/elements/oneART/source/component-libraries.rst
@@ -8,7 +8,13 @@ Component Libraries
 
 There are 4 domains.
 
+- :ref:`embree-section`: Geometric Ray Tracing Kernel API
+- :ref:`openvkl-section`: Volumetric Ray Tracing Kernel API
+- :ref:`oidn-section`: High-Fidelity [AI] Image Denoising API
+- :ref:`ospray-section`: Middleware Scalable Ray Tracing and Rendering API
+
 .. toctree::
+   :hidden:
    :maxdepth: 1
 
    embree
diff --git a/source/elements/oneART/source/conf.py b/source/elements/oneART/source/conf.py
@@ -21,8 +21,13 @@
 from os.path import join
 
 
-project = 'oneART'
+project = 'Advanced Ray Tracing'
 
 repo_root = join('..', '..', '..', '..')
 exec(open(join(repo_root, 'source', 'conf', 'common_conf.py')).read())
 exec(open(join(repo_root, 'source', 'conf', 'element_conf.py')).read())
+
+exclude_patterns = ['nested-*.rst',
+                    '**/*.inc.rst',
+                    '*.inc.rst',
+]
diff --git a/source/elements/oneART/source/embree.rst b/source/elements/oneART/source/embree.rst
@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. _embree-section:
+
 ======
 Embree
 ======
diff --git a/source/elements/oneART/source/index.rst b/source/elements/oneART/source/index.rst
@@ -11,27 +11,12 @@ Advanced Ray Tracing
 Overview
 --------
 
-Advanced ray tracing defines a set of ray tracing and high-fidelity
-rendering and computation routines for use in a wide variety of 3D
-graphics uses including, film and television photorealistic visual
-effects and animation rendering, scientific visualization,
-high-performance computing computations, gaming, and more. Advanced
-ray tracing is designed to allow cooperative execution on a wide
-variety of computational devices: CPUs, GPUs, FPGAs, and other
-accelerators, termed “XPU” computation. The functionality is
-subdivided into several domains: geometric ray tracing computations,
-volumetric computation and rendering, path guided ray tracing, image
-denoising, and an integrated rendering infrastructure and API
-utilizing all the individual kernel capabilities integrated into a
-highly capable, easy to use rendering engine.
-
-The individual components and their APIs are described.  Other design
-considerations and related components that are not necessarily part of
-the advanced ray tracing specification but that are worth mentioning
-will be discussed in the appendix.
+.. include:: overview.inc.rst
 
 .. toctree::
    :maxdepth: 1
 
    component-libraries
    appendices
+   versions
+   
diff --git a/source/elements/oneART/source/ispc.rst b/source/elements/oneART/source/ispc.rst
@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. _ispc-section:
+
 ===================================
 ISPC Implicit SPMD Program Compiler
 ===================================
diff --git a/source/elements/oneART/source/nested-index.rst b/source/elements/oneART/source/nested-index.rst
@@ -0,0 +1,20 @@
+.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. _oneart-section:
+
+====================
+Advanced Ray Tracing
+====================
+
+Overview
+--------
+
+.. include:: overview.inc.rst
+
+.. toctree::
+   :maxdepth: 1
+
+   component-libraries
+   appendices
diff --git a/source/elements/oneART/source/oidn.rst b/source/elements/oneART/source/oidn.rst
@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. _oidn-section:
+
 ==================
 Open Image Denoise
 ==================
diff --git a/source/elements/oneART/source/openvkl.rst b/source/elements/oneART/source/openvkl.rst
@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. _openvkl-section:
+
 ========
 Open VKL
 ========
diff --git a/source/elements/oneART/source/ospray-hydra-plugin.rst b/source/elements/oneART/source/ospray-hydra-plugin.rst
@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. _ospray-hydra-plugin-section:
+
 ============================
 OSPRay Plug-in for USD Hydra
 ============================
diff --git a/source/elements/oneART/source/ospray-studio.rst b/source/elements/oneART/source/ospray-studio.rst
@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. _ospray-studio-section:
+
 =============
 OSPRay Studio
 =============
diff --git a/source/elements/oneART/source/ospray.rst b/source/elements/oneART/source/ospray.rst
@@ -2,6 +2,8 @@
 ..
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. _ospray-section:
+
 ========
  OSPRay
 ========
diff --git a/source/elements/oneART/source/overview.inc.rst b/source/elements/oneART/source/overview.inc.rst
@@ -0,0 +1,22 @@
+.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+Advanced ray tracing defines a set of ray tracing and high-fidelity
+rendering and computation routines for use in a wide variety of 3D
+graphics uses including, film and television photorealistic visual
+effects and animation rendering, scientific visualization,
+high-performance computing computations, gaming, and more. Advanced
+ray tracing is designed to allow cooperative execution on a wide
+variety of computational devices: CPUs, GPUs, FPGAs, and other
+accelerators, termed “XPU” computation. The functionality is
+subdivided into several domains: geometric ray tracing computations,
+volumetric computation and rendering, path guided ray tracing, image
+denoising, and an integrated rendering infrastructure and API
+utilizing all the individual kernel capabilities integrated into a
+highly capable, easy to use rendering engine.
+
+The individual components and their APIs are described.  Other design
+considerations and related components that are not necessarily part of
+the advanced ray tracing specification but that are worth mentioning
+will be discussed in the appendix.
diff --git a/source/elements/oneART/source/versions.rst b/source/elements/oneART/source/versions.rst
@@ -0,0 +1,19 @@
+.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+==========
+ Versions
+==========
+
+This section describes the versions that were available at time of
+publication. See the `latest specification`_ for updates.
+
+==================  ==========
+Version             Date      
+==================  ==========
+`0.5 rev 1`_        2/15/2021
+==================  ==========
+
+.. _`0.5 rev 1`: https://spec.oneapi.com/oneART/versions/latest
+.. _`latest specification`: https://spec.oneapi.com/versions/latest/versions.html
diff --git a/source/index.rst b/source/index.rst
@@ -29,6 +29,6 @@ for creating parallel applications:
    elements/oneTBB/source/nested-index
    elements/oneVPL/source/index
    elements/oneMKL/source/index
-   elements/oneART/source/index
+   elements/oneART/source/nested-index
    versions
    notices

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"version": "1.0-rev-2",`
`3`		`- "vpl_version": "2.1.0"`
	`3`	`+ "vpl_version": "2.1.0",`
	`4`	`+ "art_version": "0.5-rev-1"`
`4`	`5`	`}`