Skip to content

Commit d704bfc

Browse files
author
Colin Davidson
authored
Merge pull request uxlfoundation#938 from coldav/colin/publish_docs
Combine rfc and normal documentation
2 parents ddf0cb4 + 19023e1 commit d704bfc

10 files changed

Lines changed: 142 additions & 17 deletions

File tree

‎.github/workflows/combined_docs/_layouts/toplevel.html‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!DOCTYPE html>
2+
<html lang="{{ page.lang | default: site.lang | default: "en-US" }}">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
8+
{% seo %}
9+
<link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
10+
{% include head-custom.html %}
11+
</head>
12+
<body>
13+
<div class="container-lg px-3 my-5 markdown-body">
14+
{% if site.title and site.title != page.title %}
15+
<h1><a href="{{ "/" | absolute_url }}">{{ site.title }}</a></h1>
16+
{% endif %}
17+
18+
<h1>{{ page.title }}</h1>
19+
20+
{{ content }}
21+
22+
{% if site.github.private != true and site.github.license %}
23+
<div class="footer border-top border-gray-light mt-5 pt-3 text-right text-gray">
24+
This site is open source. {% github_edit_link "Improve this page" %}.
25+
</div>
26+
{% endif %}
27+
</div>
28+
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js" integrity="sha256-lZaRhKri35AyJSypXXs4o6OPFTbTmUoltBbDCbdzegg=" crossorigin="anonymous"></script>
29+
<script>anchors.add();</script>
30+
</body>
31+
</html>

‎.github/workflows/combined_docs/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
author: oneAPI Construction Kit editors
3+
permalink: index.html
4+
layout: toplevel
5+
---
6+
7+
The majority of the general technical documentation for the oneAPI Construction Kit can be found <a href="ock/index.html">here</a>.
8+
For RFCS (request for comments) documentation, this can be found <a href="rfc-0000.html">here</a>

‎.github/workflows/publish_docs.yml‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Workflow for building and deploying a Jekyll site to GitHub Pages for docs and rfcs
2+
name: Deploy Jekyll with GitHub Pages dependencies preinstalled
3+
4+
on:
5+
pull_request:
6+
paths:
7+
- '.github/workflows/publish_docs.yml'
8+
schedule:
9+
# Run Mon at 6pm
10+
- cron: '0 18 * * 1'
11+
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
17+
permissions:
18+
contents: read
19+
pages: write
20+
id-token: write
21+
22+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
23+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
24+
concurrency:
25+
group: "pages"
26+
cancel-in-progress: true
27+
28+
jobs:
29+
30+
build_ock_docs:
31+
if: github.repository == 'uxlfoundation/oneapi-construction-kit' || github.event_name == 'workflow_dispatch'
32+
runs-on: ubuntu-latest
33+
steps:
34+
- name: Checkout
35+
uses: actions/checkout@v4
36+
37+
- uses: actions/setup-python@v5
38+
with:
39+
python-version: 3.9
40+
41+
- name: Install apt package
42+
run: |
43+
sudo apt-get update
44+
sudo apt-get install -y doxygen virtualenv
45+
46+
- name: Install prerequisites
47+
run: python -m pip install -r doc/requirements.txt
48+
49+
- name: Build Documentation
50+
working-directory: ${{github.workspace}}
51+
run: |
52+
cmake -DCMAKE_BUILD_TYPE=Debug -DCA_RUNTIME_COMPILER_ENABLED=OFF -DCA_CL_ENABLE_OFFLINE_KERNEL_TESTS=OFF -DOCL_EXTENSION_cl_khr_il_program=OFF -Bbuild_doc
53+
cmake --build build_doc --target doc_html
54+
mkdir docs
55+
mv build_doc/doc/html docs/ock
56+
57+
- name: Checkout
58+
uses: actions/checkout@v4
59+
with:
60+
ref: rfcs
61+
path: rfcs
62+
63+
- name: Move rfcs to build_doc
64+
shell: bash
65+
run: |
66+
mv rfcs/* docs
67+
cp -r $GITHUB_WORKSPACE/.github/workflows/combined_docs/* docs
68+
69+
# TODO : Remove from original rfc docs
70+
sed -i 's/permalink: index/permalink: rfc-0000/' docs/rfc-0000.md
71+
sed -i 's/split.size == 2 %/split.size == 2 and page.rfc %/' docs/rfc-0000.md
72+
73+
- name: Setup Pages
74+
uses: actions/configure-pages@v5
75+
- name: Build with Jekyll
76+
uses: actions/jekyll-build-pages@v1
77+
with:
78+
source: ./docs
79+
destination: ./_site
80+
- name: Upload artifact
81+
uses: actions/upload-pages-artifact@v3
82+
83+
# Deployment job
84+
deploy:
85+
environment:
86+
name: github-pages
87+
url: ${{ steps.deployment.outputs.page_url }}
88+
runs-on: ubuntu-latest
89+
needs: [ build_ock_docs ]
90+
steps:
91+
- name: Deploy to GitHub Pages
92+
id: deployment
93+
uses: actions/deploy-pages@v4

‎doc/cmake/FindModules.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ FindGitClangFormat Module
3939
.. seealso::
4040
Used to implement the :doc:`/cmake/Format`.
4141

42-
FindLLVMTool Module
42+
ImportLLVM Module
4343
###################
4444

45-
.. cmake-module:: ../../cmake/FindLLVMTool.cmake
45+
.. cmake-module:: ../../cmake/ImportLLVM.cmake
4646

4747
FindLit Module
4848
##############

‎doc/developer-guide.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -745,7 +745,7 @@ To cross-compile LLVM the appropriate CMake toolchain file from the oneAPI
745745
Construction Kit repository may be used; the path to this repository will be
746746
specified by the `$ONEAPI_CON_KIT` variable in the following examples.
747747

748-
##### Cross-compiling LLVM for ARM
748+
#### Cross-compiling LLVM for ARM
749749

750750
For cross-compilation targeting ARM, only the `ARM` target back end needs to be
751751
enabled. Run the following command to configure an LLVM build targeting ARM from
@@ -770,7 +770,7 @@ Now the build directory is configured, build the `install` target.
770770
ninja -C build-arm install
771771
```
772772

773-
##### Cross-compiling LLVM for AArch64
773+
#### Cross-compiling LLVM for AArch64
774774

775775
For cross-compilation targeting AArch64 only the `AArch64` target back end needs
776776
to be enabled. Run the following command to configure an LLVM build targeting
@@ -795,7 +795,7 @@ Now the build directory is configured, build the `install` target.
795795
ninja -C build-aarch64 install
796796
```
797797

798-
##### Cross-compiling LLVM for RISC-V
798+
#### Cross-compiling LLVM for RISC-V
799799

800800
For cross-compilation targeting RISC-V only the `RISCV` target back end needs
801801
to be enabled. Run the following command to configure an LLVM build targeting

‎doc/getting-started.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ configuration.
113113
* `Git`_
114114
* `CMake`_ 3.4.3+
115115
* `Python`_ 3.6.9+
116-
* `Vulkan SDK`_ 1.1.97+
116+
* `LunarG Vulkan SDK packages`_ 1.1.97+
117117

118118
Windows 10 does not provide an adequate package manager. However, the
119119
third-party `Chocolatey <https://chocolatey.org/install#install-with-cmdexe>`_

‎doc/modules/mux.rst‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,6 @@ ComputeMux
99
CMake <mux/cmake>
1010
Bumping the Specification Version <mux/bumping-the-spec>
1111

12-
.. toctree::
13-
:hidden:
14-
15-
mux/hal/dynamic_loading
16-
1712
.. seealso::
1813
The :doc:`/specifications/mux-runtime-spec` and the
1914
:doc:`/specifications/mux-compiler-spec`.

‎doc/modules/mux/changes.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,11 @@ version increases mean backward compatible bug fixes have been applied.
5353

5454
* Several ``compiler::BaseModule`` methods and fields have been reworked to
5555
make compilation of OpenCL less stateful.
56-
* The class-member lists of macro defs and OpenCL options have been removed,
56+
- The class-member lists of macro defs and OpenCL options have been removed,
5757
and are set up and torn down on the fly when compiling OpenCL C.
58-
* Several methods such as ``compiler::BaseModule::populatePPOpts`` are now
58+
- Several methods such as ``compiler::BaseModule::populatePPOpts`` are now
5959
``const``.
60-
* ``compiler::BaseModule::executeOpenCLAction`` has been removed.
60+
- ``compiler::BaseModule::executeOpenCLAction`` has been removed.
6161

6262
0.73.0
6363
------

‎doc/overview/compiler/ir.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -624,8 +624,7 @@ the `OpenCL C atomic`_ and `OpenCL C fence`_ operations and the `SPIR-V atomic`_
624624
and `SPIR-V barrier`_ operations. Synchronization on non-atomic memory access
625625
is defined by a *memory consistency model*. The memory consistency requirements
626626
made on the instruction listed in the Mux compiler spec enables the oneAPI
627-
Construction Kit to support the higher level `OpenCL memory consistency model`_
628-
and the `Vulkan memory model`_.
627+
Construction Kit to support the higher level `OpenCL memory consistency model`_.
629628

630629
.. _OpenCL C atomic:
631630
https://www.khronos.org/registry/OpenCL/specs/3.0-unified/html/OpenCL_C.html#atomic-functions

‎doc/specifications.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,3 @@ Specifications
77
specifications/versioning
88
specifications/mux-runtime-spec
99
specifications/mux-compiler-spec
10-
specifications/hal

0 commit comments

Comments
 (0)