merge from master

Author: rscohn2

.gitlab-ci-onetbb.yml

@@ -0,0 +1,18 @@
+build_tbb_spec:
+  stage: build
+  tags: [python-sphinx]
+  script:
+    - sphinx-build -b html source/elements/oneTBB/source onetbb_spec
+  artifacts:
+    paths: [onetbb_spec]
+    expire_in: 3d
+
+pages:
+  stage: deploy
+  tags: [linux]
+  needs: [build_tbb_spec]
+  only: [develop]
+  script:
+  - mv onetbb_spec public
+  artifacts:
+    paths: [public]

README.rst

@@ -2,6 +2,9 @@
 oneAPI Specifications
 =====================
 
+.. image:: https://github.com/oneapi-src/oneapi-spec/workflows/CI/badge.svg
+   :target: https://github.com/oneapi-src/oneapi-spec/actions?query=workflow%3ACI
+
 This repo contains the sources for the `oneAPI Specification`_
 
 The document is built with `Sphinx`_ using a theme provided by `Read
@@ -122,28 +125,19 @@ You can run a docker container with::
 CI
 --
 
-We are currently using gitlab CI inside the intel firewall. We expect
-all the sources to be in this repo by the 3/26/2020 release, and will
-move the CI system to a public service.
-
-See .gitlab-ci.yml for the CI configuration. The CI monitors and
-builds 2 repo's inside Intel. oneapi-spec-mirror is a mirror of the
-repo on github. Turnaround for testing depends on the interval between
-mirroring updates, which appears to be ~30 minutes. For quick
-turnaround, you can push your branch to the oneapi-spec-test repo,
-which will be built immmediately.
+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 in the
-CI system.
+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
-in the CI system.
-
-To push to S3, the CI system configuration sets AWS_ACCESS_KEY_ID and
-AWS_SECRET_ACCESS_KEY environment variables.
+for the build step in the CI system.
 
 ----------
 Publishing

source/conf.py

@@ -27,7 +27,7 @@
 
 # The short X.Y version
 #version = u'0.61 <' + str(datetime.date.today()) + '>'
-version = u'0.6.0' 
+version = u'0.6.1' 
 # The full version, including alpha/beta/rc tags
 release = version
 
@@ -101,6 +101,7 @@
 # documentation.
 #
 html_theme_options = {
+  'includehidden': False
 } 
 
 html_context = {

source/elements/l0/source/index.rst

@@ -42,4 +42,4 @@ Detailed API Descriptions
 
 The detailed specification for Level Zero is available `online`_.
 
-.. _`online`: ../../../oneL0/index.html
+.. _`online`: https://spec.oneapi.com/versions/0.6.0/oneL0/index.html

source/elements/oneDAL/source/index.rst

@@ -124,5 +124,5 @@ The detailed specification for oneDAL is available `online`_.
 
 .. _`open source implementation`: https://github.com/intel/daal
 .. _`README`: https://github.com/intel/daal/blob/master/README.md
-.. _`online`: ../../../oneDAL/index.html
+.. _`online`: https://spec.oneapi.com/versions/0.6.0/oneDAL/index.html
 

source/elements/oneMKL/source/index.rst

@@ -35,4 +35,4 @@ Detailed API Descriptions
 The detailed list of functions and their specification can be found in
 the `oneMKL specification`_.
 
-.. _`oneMKL specification`: ../../../oneMKL/index.htm
+.. _`oneMKL specification`: https://spec.oneapi.com/versions/0.6.0/oneMKL/index.htm

source/index.rst

@@ -24,6 +24,13 @@ oneAPI Specification
    elements/oneVPL/source/index
    elements/oneMKL/source/index
    contributors
+   versions
    notices
 
-   
+.. sphinx warns about rst files that are not reachable from the top
+   level toc. Put them here:
+
+.. toctree::
+   :hidden:
+
+   404

source/introduction.rst

@@ -120,25 +120,6 @@ If you agree to the above, every contribution of your feedback must
 include the following line using your real name and email address:
 Signed-off-by: Joe Smith [email protected]
 
-Versions
---------
-
-========  ==========  =========
-Version   Date        View                                                                                                            
-========  ==========  =========
-0.6.0_    01/31/2019  `HTML <https://spec.oneapi.com/versions/0.6.0/>`__ `PDF <https://spec.oneapi.com/versions/0.6.0/oneAPI-spec.pdf>`__
-0.5.0_    11/17/2019  `HTML <https://spec.oneapi.com/versions/0.5.0/>`__                                                                
-========  ==========  =========
-
-0.6.0
-+++++
-
-Open source release
-
-0.5.0
-+++++
-
-Initial public release
 
 .. todolist::
 

source/versions.rst

@@ -0,0 +1,28 @@
+..
+  Copyright 2020 Intel Corporation
+
+
+HTML and PDF Versions
+=====================
+
+These are the versions that were available at time of publication. See
+the `latest spec
+<https://spec.oneapi.com/versions/latest/versions.html>`__ for newer
+versions.
+
+========  ==========  =========
+Version   Date        View                                                                                                            
+========  ==========  =========
+0.6.0_    01/31/2019  `HTML <https://spec.oneapi.com/versions/0.6.0/>`__ `PDF <https://spec.oneapi.com/versions/0.6.0/oneAPI-spec.pdf>`__
+0.5.0_    11/17/2019  `HTML <https://spec.oneapi.com/versions/0.5.0/>`__                                                                
+========  ==========  =========
+
+0.6.0
++++++
+
+Open source release
+
+0.5.0
++++++
+
+Initial public release