Skip to content

Commit 5e9f4c8

Browse files
[CI] Remove Doxygen docs from intel.github.io/llvm-docs/ (#15482)
Prequel of #15483 This PR removes Doxygen docs/links from intel.github.io/llvm-docs/. This is done to reduce the size of the website so that it can be hosted via artifacts in #15483. [intel/llvm-docs](https://github.com/intel/llvm-docs) repository will soon be decommissioned.
1 parent f84d491 commit 5e9f4c8

File tree

6 files changed

+2
-26
lines changed

6 files changed

+2
-26
lines changed

.github/workflows/sycl-docs.yml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Generate Doxygen documentation
1+
name: Generate documentation
22

33
on:
44
schedule:
@@ -25,16 +25,14 @@ jobs:
2525
path: repo
2626
- name: Install deps
2727
run: |
28-
sudo apt-get install -y doxygen graphviz ssh ninja-build libhwloc-dev
28+
sudo apt-get install -y graphviz ssh ninja-build libhwloc-dev
2929
sudo pip3 install -r repo/llvm/docs/requirements.txt
3030
- name: Build Docs
3131
run: |
3232
mkdir -p $GITHUB_WORKSPACE/build
3333
cd $GITHUB_WORKSPACE/build
3434
python $GITHUB_WORKSPACE/repo/buildbot/configure.py -w $GITHUB_WORKSPACE \
3535
-s $GITHUB_WORKSPACE/repo -o $GITHUB_WORKSPACE/build -t Release --docs
36-
cmake --build . --target doxygen-sycl
37-
cmake --build . --target doxygen-clang
3836
cmake --build . --target docs-sycl-html
3937
cmake --build . --target docs-clang-html
4038
- name: Deploy
@@ -52,9 +50,7 @@ jobs:
5250
git rm -rf .
5351
touch .nojekyll
5452
yes | \cp -rf $GITHUB_WORKSPACE/build/tools/sycl/doc/html/* .
55-
mv $GITHUB_WORKSPACE/build/tools/sycl/doc/doxygen/html doxygen/
5653
mv $GITHUB_WORKSPACE/build/tools/clang/docs/html clang/
57-
mv $GITHUB_WORKSPACE/build/tools/clang/docs/doxygen/html clang_doxygen/
5854
git config --global user.name "iclsrc"
5955
git config --global user.email "[email protected]"
6056
git add .

buildbot/configure.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,6 @@ def do_configure(args):
116116
llvm_enable_assertions = "OFF"
117117

118118
if args.docs:
119-
llvm_enable_doxygen = "ON"
120119
llvm_enable_sphinx = "ON"
121120

122121
if args.shared_libs:

sycl/doc/extensions/supported/sycl_ext_intel_esimd/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ vectorization is expressed explicitly in the code by the programmer.
1616
Please see the additional resources on the Intel DPC++ project's github:
1717

1818
1) [ESIMD Extension Specification](./sycl_ext_intel_esimd.md)
19-
1) [ESIMD API/doxygen reference](https://intel.github.io/llvm-docs/doxygen/group__sycl__esimd.html)
2019
1) [Examples](./examples/README.md)
2120
1) [ESIMD end-to-end LIT tests](https://github.com/intel/llvm/blob/sycl/sycl/test-e2e/ESIMD/)
2221
1) [Implementation and API Restrictions](./sycl_ext_intel_esimd.md#implementation-restrictions)

sycl/doc/extensions/supported/sycl_ext_intel_esimd/sycl_ext_intel_esimd.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@
3838
- [Other restrictions](#other-restrictions)
3939

4040
## Other content:
41-
* [ESIMD API/doxygen reference](https://intel.github.io/llvm-docs/doxygen/group__sycl__esimd.html)
4241
* [Examples](./examples/README.md)
4342
* [ESIMD LIT tests - working code examples](https://github.com/intel/llvm/blob/sycl/sycl/test-e2e/ESIMD/)
4443

@@ -162,7 +161,6 @@ The element type must either be a vectorizable type or the `sycl::half` type.
162161
The set of vectorizable types is the
163162
set of fundamental SYCL arithmetic types excluding `bool`. The length of the
164163
vector is the second template parameter.
165-
See the complete [API reference](https://intel.github.io/llvm-docs/doxygen/classcl_1_1____ESIMD__NS_1_1simd.html#details) for the `simd` class for more details.
166164

167165
ESIMD compiler back-end does the best it can to map each `simd` class object to a
168166
contiguous block of registers in the general register file (GRF).
@@ -351,8 +349,6 @@ reduction operations are supported:
351349
- maximum
352350
- minimum
353351

354-
See more details on the API documentation [page TODO](https://intel.github.io/llvm-docs/doxygen).
355-
356352
### Memory access APIs
357353

358354
Explicit SIMD memory access interface is quite different from the standard SYCL
@@ -598,9 +594,6 @@ Many memory access APIs accept offsets as arguments, which are used to determine
598594
actual memory location for the access. Offsets are always expressed in bytes
599595
rather than element units.
600596
601-
See more details in the API documentation
602-
[page TODO](https://intel.github.io/llvm-docs/doxygen).
603-
604597
### Math operations
605598
606599
#### Extended math
@@ -649,10 +642,6 @@ ESIMD supports the following non-standard math functions implemented in hardware
649642
- Plane equation - `plane`. Solves a component-wise plane equation
650643
`w = p*u + q*v + r` where `u`, `v`, `w` are vectors and `p`, `q`, `r` are scalars.
651644
652-
653-
See more details in the API documentation
654-
[page TODO](https://intel.github.io/llvm-docs/doxygen).
655-
656645
### Dot Product Accumulate Systolic - `DPAS` API
657646
658647
DPAS is the matrix multiply-add-and-accumulate operation performed on limited size matrices/tiles.
@@ -870,9 +859,6 @@ There are other useful miscellaneous APIs provided by ESIMD.
870859
- Find least significant set bit - `fbl`.
871860
- Find most significant set bit - `fbh`.
872861

873-
See more details in the API documentation
874-
[page TODO](https://intel.github.io/llvm-docs/doxygen).
875-
876862
<br>
877863

878864
### Private Global Variables.

sycl/doc/extensions/supported/sycl_ext_intel_esimd/sycl_ext_intel_esimd_functions.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ See more general ESIMD documentation [here](./sycl_ext_intel_esimd.md).
2222

2323
## Other content:
2424
* [General ESIMD documentation](./sycl_ext_intel_esimd.md)
25-
* [ESIMD API/doxygen reference](https://intel.github.io/llvm-docs/doxygen/group__sycl__esimd.html)
2625
* [Examples](./examples/README.md)
2726
* [ESIMD LIT tests - working code examples](https://github.com/intel/llvm/blob/sycl/sycl/test-e2e/ESIMD/)
2827

sycl/doc/index.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ Using oneAPI DPC++ for Application Development
1515
Extensions <https://github.com/intel/llvm/tree/sycl/sycl/doc/extensions>
1616
syclcompat/README.md
1717
FAQ
18-
User API Reference <https://intel.github.io/llvm-docs/doxygen/group__sycl__api.html>
1918
EnvironmentVariables
2019
MultiTileCardWithLevelZero
2120
syclgraph/SYCLGraphUsageGuide
@@ -26,9 +25,7 @@ Design Documents for the oneAPI DPC++ Compiler
2625
.. toctree::
2726
:maxdepth: 1
2827

29-
API Reference <https://intel.github.io/llvm-docs/doxygen>
3028
Clang Documentation <https://intel.github.io/llvm-docs/clang>
31-
Clang API Reference <https://intel.github.io/llvm-docs/clang_doxygen>
3229
design/CompilerAndRuntimeDesign
3330
design/KernelParameterPassing
3431
design/PluginInterface

0 commit comments

Comments
 (0)