ssf compliance updates (#516)

disable parallel build, breathe does not support it

.github/workflows/ci.yml → .github/workflows/pr.yml

@@ -2,6 +2,9 @@
 #
 # SPDX-License-Identifier: MIT
 
+name: "PR Tests"
+permissions: read-all
+
 on:
   push:
     branches:
@@ -12,26 +15,26 @@ jobs:
   checks:
     runs-on: ${{ github.repository_owner == 'oneapi-src' && 'intel-ubuntu-latest' || 'ubuntu-latest' }}
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
+    - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
+    - uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c
       with:
         python-version: '3.10'
         cache: 'pip'
     - name: Checks
-      uses: pre-commit/action@v3.0.0
+      uses: pre-commit/action@646c83fcd040023954eafda54b4db0192ce70507
 
   build:
     runs-on: ${{ github.repository_owner == 'oneapi-src' && 'intel-ubuntu-latest' || 'ubuntu-latest' }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
     - name: Install ubuntu prerequisites
       run: |
         sudo apt update -qq
         xargs -a ubuntu-packages.txt sudo apt install -qq
         curl -s https://www.doxygen.nl/files/doxygen-1.9.6.linux.bin.tar.gz -o /tmp/dox.tgz
         sudo tar zxf /tmp/dox.tgz -C /usr/local
         sudo ln -s /usr/local/doxygen*/bin/* /usr/bin
-    - uses: actions/setup-python@v4
+    - uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c
       with:
         python-version: '3.10'
         cache: 'pip'
@@ -54,7 +57,7 @@ jobs:
         cp -r build/html/* site/spec
         cp build/latex/*.pdf site/spec
     - name: Archive site
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8
       with:
         name: site
         path: site
@@ -65,12 +68,12 @@ jobs:
     runs-on: ${{ github.repository_owner == 'oneapi-src' && 'intel-ubuntu-latest' || 'ubuntu-latest' }}
     steps:
     - name: Checkout gh-pages
-      uses: actions/checkout@v3
+      uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
       with:
         ref: gh-pages
         path: gh-pages
     - name: Retrieve site
-      uses: actions/download-artifact@v3
+      uses: actions/download-artifact@6b208ae046db98c579e8a3aa621ab581ff575935
       with:
         name: site
         path: gh-pages

README.rst

@@ -6,8 +6,8 @@
 oneAPI Specifications
 =====================
 
-.. image:: https://github.com/oneapi-src/oneAPI-spec/actions/workflows/ci.yml/badge.svg
-   :target: https://github.com/oneapi-src/oneapi-spec/actions?query=workflow%3ACI
+.. image:: https://github.com/oneapi-src/oneAPI-spec/actions/workflows/pr.yml/badge.svg
+   :target: https://github.com/oneapi-src/oneapi-spec/actions/workflows/pr.yml
 
 .. image:: https://api.reuse.software/badge/github.com/oneapi-src/oneapi-spec
    :target: https://api.reuse.software/info/github.com/oneapi-src/oneapi-spec

requirements.base.txt

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: 2019-2020 Intel Corporation
+#
+# SPDX-License-Identifier: MIT
+
+# This is the minimal set of components required and using the latest
+#  versions
+
+breathe
+graphviz
+lxml
+pre-commit
+six
+Sphinx
+sphinx-notfound-page
+sphinx-book-theme
+sphinx-prompt
+sphinx_substitution_extensions
+sphinx_tabs
+sphinxcontrib.plantuml
+sphinxcontrib-spelling
+sphinxcontrib-svg2pdfconverter
+sphinxmark

requirements.header.txt

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2019-2020 Intel Corporation
+#
+# SPDX-License-Identifier: MIT
+
+# This file is generated with:
+#
+# rm -rf venv
+# python -m venv venv
+# source venv/bin/activate
+# pip install -r requirements.base.txt
+# cp requirements.header.txt requirements.txt
+# pip freeze >> requirements.txt
+#
+# Add this header, including copyright back
+#

requirements.txt

@@ -2,20 +2,65 @@
 #
 # SPDX-License-Identifier: MIT
 
-# This is the minimal set of components required and using the latest
-#  versions
-
-breathe
-graphviz
-lxml
-six
-Sphinx
-sphinx-notfound-page
-sphinx-book-theme
-sphinx-prompt
-sphinx_substitution_extensions
-sphinx_tabs
-sphinxcontrib.plantuml
-sphinxcontrib-spelling
-sphinxcontrib-svg2pdfconverter
-sphinxmark
+# This file is generated with:
+#
+# rm -rf venv
+# python -m venv venv
+# source venv/bin/activate
+# pip install -r requirements.base.txt
+# cp requirements.header.txt requirements.txt
+# pip freeze >> requirements.txt
+#
+# Add this header, including copyright back
+#
+accessible-pygments==0.0.4
+alabaster==0.7.16
+Babel==2.14.0
+beautifulsoup4==4.12.3
+bottle==0.12.25
+breathe==4.35.0
+certifi==2024.2.2
+cfgv==3.4.0
+charset-normalizer==3.3.2
+distlib==0.3.8
+docutils==0.20.1
+filelock==3.13.1
+graphviz==0.20.1
+identify==2.5.33
+idna==3.6
+imagesize==1.4.1
+Jinja2==3.1.3
+lxml==5.1.0
+MarkupSafe==2.1.5
+nodeenv==1.8.0
+packaging==23.2
+pillow==10.2.0
+platformdirs==4.2.0
+pre-commit==3.6.0
+pydata-sphinx-theme==0.15.2
+pyenchant==3.2.2
+Pygments==2.17.2
+PyYAML==6.0.1
+requests==2.31.0
+six==1.16.0
+snowballstemmer==2.2.0
+soupsieve==2.5
+Sphinx==7.2.6
+sphinx-book-theme==1.1.0
+sphinx-notfound-page==1.0.0
+sphinx-prompt==1.8.0
+Sphinx-Substitution-Extensions==2022.2.16
+sphinx-tabs==3.4.5
+sphinxcontrib-applehelp==1.0.8
+sphinxcontrib-devhelp==1.0.6
+sphinxcontrib-htmlhelp==2.0.5
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-plantuml==0.27
+sphinxcontrib-qthelp==1.0.7
+sphinxcontrib-serializinghtml==1.1.10
+sphinxcontrib-spelling==8.0.0
+sphinxcontrib-svg2pdfconverter==1.2.2
+sphinxmark==1.0.0
+typing_extensions==4.9.0
+urllib3==2.2.0
+virtualenv==20.25.0

scripts/oneapi.py

@@ -94,8 +94,6 @@ def sphinx(root, target):
     sphinx_args = '-N'
     if not cl_args.verbose:
         sphinx_args += ' -q'
-    if not cl_args.serial:
-        sphinx_args += ' -j auto'
     if cl_args.a:
         sphinx_args += ' -a'
     if cl_args.n:
@@ -272,7 +270,6 @@ def main():
     parser.add_argument('--branch')
     parser.add_argument('--verbose', action='store_true')
     parser.add_argument('--dry-run', action='store_true')
-    parser.add_argument('--serial', action='store_true')
     parser.add_argument('-W', action='store_true')
     parser.add_argument(
         '-a', action='store_true', help='sphinx -a (build all files)'