Skip to content

Commit f3cf52a

Browse files
rscohn2rscohn2
authored
Move releases to external doc (#313)
1 parent d6261ca commit f3cf52a

File tree

6 files changed

+291
-222
lines changed

6 files changed

+291
-222
lines changed

‎releases/Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?= -q -W -n
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎releases/conf.py‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
# import os
14+
# import sys
15+
# sys.path.insert(0, os.path.abspath('.'))
16+
17+
18+
# -- Project information -----------------------------------------------------
19+
20+
project = 'oneAPI Specification Versions'
21+
copyright = '2021, Intel Corporation'
22+
author = 'Intel Corporation'
23+
24+
25+
# -- General configuration ---------------------------------------------------
26+
27+
# Add any Sphinx extension module names here, as strings. They can be
28+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
29+
# ones.
30+
extensions = [
31+
]
32+
33+
# Add any paths that contain templates here, relative to this directory.
34+
templates_path = ['_templates']
35+
36+
# List of patterns, relative to source directory, that match files and
37+
# directories to ignore when looking for source files.
38+
# This pattern also affects html_static_path and html_extra_path.
39+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
40+
41+
42+
# -- Options for HTML output -------------------------------------------------
43+
44+
# The theme to use for HTML and HTML Help pages. See the documentation for
45+
# a list of builtin themes.
46+
#
47+
html_theme = 'sphinx_book_theme'
48+
49+
html_theme_options = {
50+
'repository_url': 'https://github.com/oneapi-src/oneapi-spec',
51+
'path_to_docs': 'versions',
52+
'use_issues_button': True,
53+
'use_edit_page_button': True,
54+
'repository_branch': 'main',
55+
'single_page': True
56+
}
57+
58+
# Add any paths that contain custom static files (such as style sheets) here,
59+
# relative to this directory. They are copied after the builtin static files,
60+
# so a file named "default.css" will overwrite the builtin "default.css".
61+
html_static_path = ['_static']

‎releases/index.rst‎

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
1+
.. oneAPI Specification Versions documentation master file, created by
2+
sphinx-quickstart on Thu Apr 8 09:51:39 2021.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
===============================
7+
oneAPI Specification Releases
8+
===============================
9+
10+
11+
This document lists releases of oneAPI specifications.
12+
13+
In addition to be published as part of the oneAPI spefication, some of
14+
the components publish specifications independent from the oneAPI
15+
specification. Typically, a oneAPI specification includes a snapshot
16+
of the latest approved release of the component. This page lists
17+
releases of the oneAPI specification and releases of component
18+
specifications. Releases of collections of oneAPI components
19+
(e.g. Intel oneAPI Basekit) identify the version of the oneAPI
20+
specification that it supports.
21+
22+
23+
oneAPI Specification
24+
====================
25+
26+
The latest approved specification is 1.0. The 1.1 specification is
27+
under development and is labeled *provisional* until it is approved.
28+
29+
30+
1.1
31+
---
32+
33+
.. list-table::
34+
:widths: 30 20 50
35+
:header-rows: 1
36+
37+
* - Version
38+
- Date
39+
- View
40+
* - `1.1 provisional rev 1`_
41+
- 2020-4-7
42+
- `HTML <https://spec.oneapi.com/versions/1.1-provisional-rev-1/>`__ `PDF <https://spec.oneapi.com/versions/1.1-provisional-rev-1/oneAPI-spec.pdf>`__
43+
44+
45+
1.0
46+
---
47+
48+
.. list-table::
49+
:widths: 30 20 50
50+
:header-rows: 1
51+
52+
* - Version
53+
- Date
54+
- View
55+
* - `1.0 rev 2`_
56+
- 2020-10-21
57+
- `HTML <https://spec.oneapi.com/versions/1.0-rev-2/>`__ `PDF <https://spec.oneapi.com/versions/1.0-rev-2/oneAPI-spec.pdf>`__
58+
* - `1.0 rev 1`_
59+
- 2020-9-14
60+
- `HTML <https://spec.oneapi.com/versions/1.0-rev-1/>`__ `PDF <https://spec.oneapi.com/versions/1.0-rev-1/oneAPI-spec.pdf>`__
61+
62+
Release Notes
63+
-------------
64+
65+
1.1 provisional rev 1
66+
~~~~~~~~~~~~~~~~~~~~~
67+
68+
1.0 rev 2
69+
~~~~~~~~~
70+
71+
* Formatting fixes for PDF
72+
73+
1.0 rev 1
74+
~~~~~~~~~
75+
76+
* Initial release
77+
78+
Advanced Ray Tracing
79+
====================
80+
81+
.. list-table::
82+
:widths: 30 20 50
83+
:header-rows: 1
84+
85+
* - Version
86+
- Date
87+
- View
88+
* - `oneART v0.5`_
89+
- 2021-2-18
90+
- `HTML <https://spec.oneapi.com/oneart/0.5-rev-1/index.html>`__
91+
92+
93+
Release Notes
94+
-------------
95+
96+
oneART v0.5
97+
~~~~~~~~~~~
98+
99+
* Advanced ray tracing capabilities have been added to the oneAPI
100+
specification providing software developers across the industry the
101+
ability to “write once” for high-fidelity ray-traced computations
102+
across multiple vendors’ systems and accelerators. Standardizing
103+
these interfaces provides well-designed, tried and true APIs and
104+
options for a broad set of compute and rendering infrastructure
105+
development.
106+
107+
* The advanced ray tracing functionality is subdivided into several
108+
domains within the oneAPI Specification:
109+
110+
* Geometric ray tracing computations
111+
* Volumetric computation and rendering
112+
* Image denoising
113+
* Scalable rendering and visualization infrastructure
114+
115+
* The set of Advanced Ray Tracing APIs include the following, which
116+
are in active use via the Intel® oneAPI Rendering Toolkit:
117+
118+
* Embree
119+
* Open Volume Kernel Library
120+
* Open Image Denoise
121+
* OSPRay
122+
123+
124+
oneDNN Graph
125+
============
126+
127+
.. list-table::
128+
:widths: 30 20 50
129+
:header-rows: 1
130+
131+
* - Version
132+
- Date
133+
- View
134+
* - `oneDNN Graph v0.5`_
135+
- 2021-4-8
136+
- `HTML <https://spec.oneapi.com/onednn-graph/latest/index.html>`__
137+
138+
Release Notes
139+
-------------
140+
141+
oneDNN Graph v0.5
142+
~~~~~~~~~~~~~~~~~
143+
144+
oneVPL
145+
======
146+
147+
.. list-table::
148+
:widths: 30 20 50
149+
:header-rows: 1
150+
151+
* - Version
152+
- Date
153+
- View
154+
* - `oneVPL v2.3.1`_
155+
- 2021-4-8
156+
- `HTML <https://spec.oneapi.com/onevpl/2.3.1/index.html>`__
157+
158+
Release Notes
159+
-------------
160+
161+
oneVPL v2.3.1
162+
~~~~~~~~~~~~~
163+
164+
* Encoding in Hyper mode.
165+
166+
* New product names for platforms:
167+
168+
* Code name Rocket Lake,
169+
* Code name Alder Lake S,
170+
* Code name Alder Lake P,
171+
* Code name Arctic Sound P.
172+
173+
* mfx.h header file is added which includes all header files.
174+
* Added deprecation messages (deprecation macro) to the MFXInit and MFXInitEx functions definition.

‎releases/make.bat‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎source/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ for creating parallel applications:
3030
elements/oneVPL/source/index
3131
elements/oneMKL/source/index
3232
elements/oneART/source/nested-index
33-
versions
33+
Releases <https://spec.oneapi/releases/index.html>
3434
notices

0 commit comments

Comments
 (0)