oneAPI Specifications

This repo contains the sources for the oneAPI Specification. For more information about oneAPI, see oneapi.com. For information about future releases of the oneAPI specification, see the roadmap. To be notified about new releases, become a release-only watcher of this repo. See contribute for information about contributing.

The document is built with Sphinx using a theme provided by Read the Docs.

Editing with GitHub Web Interface

The simplest and quickest way to edit is directly in the GitHub web interface. It has an editor, previewer, and lets you commit changes. You won't need to install any local tools. The previewer knows how to render RST, but not the sphinx directives so it will not display exactly as the real manual.

Working with a Local Copy

For bigger edits, you will need a local version of the tools. Clone this repo to your local system. scripts/oneapi.py is a helper script for the maintenance tasks. You can also look at the source if you want to do the same task manually.

Setup

Install Python 3 and doxygen (>= 1.8.17). To install on Ubuntu:

sudo scripts/install.sh

Create and activate a Python virtual environment with all required tools:

python scripts/oneapi.py spec-venv
source spec-venv/bin/activate

To install directly with pip:

pip install -r requirements.txt

On Windows:

python scripts\oneapi.py spec-venv
spec-venv\Scripts\activate

MKL and Level Zero are temporarily in separate private repos. If you have access to the repos, you can clone them:

python scripts/oneapi.py clones

Building the docs

To build the html document:

python scripts/oneapi.py html

This will not work on Windows because we are using symbolic links for the elements that are in separate repos. However, Windows can build individual specs for individual elements.

The document is organized as a book with chapters. Each element of oneAPI is its own chapter and can be built separately. For example, to build the oneVPL chapter, do:

python scripts/oneapi.py html source/elements/oneVPL

To see the docs, visit build/html/index.html in your browser using a file:// URL. Build the pdf version with:

python scripts/oneapi.py latexpdf

And then view build/latexpdf/oneAPI-spec.pdf

Checking for Errors

There are rst linting tools to check for errors:

find . -name '*.rst' | xargs rstcheck

rstcheck finds errors in some of the template code and in the cpp examples. We may not want to try to correct them.

Editing Tools

For simple edits to individual files, you can use the GitHub web interface.

Emacs has a built-in ReST mode. It does some syntax highlighting and helps with some of the tedious aspects of ReST. M-q will rejustify long lines to fit the recommended 80 character line. It understands ReST formatting and won't mess up lists. C-= is a Swiss army knife. It will cycle between different characters for a section break adornment (e.g. --, ===,...) It will make the section break adornment match the size of the text. Probably a lot more.

Visual Studio Code has extensions for previewers and automatic linting. I could not find any support for rejustifying paragraphs to 80 characters, which makes it difficult to use.

Docker

You can build a Docker container image with:

python scripts/oneapi.py dockerbuild

The tag will be rscohn2/oneapi-spec. The script copies your proxy settings in the invoking shell so it will work inside the firewall.

You can run a docker container with:

python scripts/oneapi.py dockerrun

CI

We use GitHub actions. See .github/workflows/main.yml

On every commit, the CI system builds and publishes the document to the staging server. To see the URL, look at the end of the log for the build step in the CI system. The staging server is an s3 bucket, and the access keys are managed as GitHub action secrets. PR's based on forks do not have access to the keys and will not publish on the staging server.

For commits to the publish branch, the document is staged inside a full copy of the spec.oneapi.com site, which includes redirects and older versions of the doc. To see the URL, look at the end of the log for the build step in the CI system.

Publishing

Merge from master to publish:

git checkout publish
git merge master
git commit -m 'merge from master'

After CI completes, view the results on staging server. Push to production with:

python scripts/oneapi.py prod-publish

Then purge the CDN. Generate a list of URLs with:

python scripts/oneapi.py purge

More Reading

• oneAPI Specification Roadmap
• oneAPI Specification Style Guide
• Sphinx Documentation
• rst docs: User and reference manuals.
• online editor/viewer: Web page that lets you type in some rst fragments and view. Good for debugging.