Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[CI] Remove Doxygen docs from intel.github.io/llvm-docs/ #15482

Merged
merged 5 commits into from
Sep 25, 2024
Merged

[CI] Remove Doxygen docs from intel.github.io/llvm-docs/ #15482

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f1141ed
Remove doxygen docs from intel.github.io
uditagarwal97 Sep 24, 2024
7a3e122
Don't install doxygen in container
uditagarwal97 Sep 24, 2024
1997a3b
Update sycl-docs.yml
uditagarwal97 Sep 24, 2024
80c6576
Remove doxygen links
uditagarwal97 Sep 24, 2024
fdbcdd2
Separate out force-push in a followup PR
uditagarwal97 Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .github/workflows/sycl-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,14 @@ jobs:
path: repo
- name: Install deps
run: |
sudo apt-get install -y doxygen graphviz ssh ninja-build libhwloc-dev
sudo apt-get install -y graphviz ssh ninja-build libhwloc-dev
bader marked this conversation as resolved.
Show resolved Hide resolved
sudo pip3 install -r repo/llvm/docs/requirements.txt
- name: Build Docs
run: |
mkdir -p $GITHUB_WORKSPACE/build
cd $GITHUB_WORKSPACE/build
python $GITHUB_WORKSPACE/repo/buildbot/configure.py -w $GITHUB_WORKSPACE \
-s $GITHUB_WORKSPACE/repo -o $GITHUB_WORKSPACE/build -t Release --docs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Potentially it can be useful to verify that developers can build Doxygen documentation locally if needed. Currently, we build Doxygen documentation during pre-commit testing w/o deploying the documentation.

I don't have a strong opinion about keeping Doxygen documentation buildable. IMHO, even if broken, it should be easy to fix.
If any of code owners have an opinion, feel free to leave a comment.

cmake --build . --target doxygen-sycl
cmake --build . --target doxygen-clang
cmake --build . --target docs-sycl-html
cmake --build . --target docs-clang-html
- name: Deploy
Expand All @@ -52,9 +50,7 @@ jobs:
git rm -rf .
touch .nojekyll
yes | \cp -rf $GITHUB_WORKSPACE/build/tools/sycl/doc/html/* .
mv $GITHUB_WORKSPACE/build/tools/sycl/doc/doxygen/html doxygen/
mv $GITHUB_WORKSPACE/build/tools/clang/docs/html clang/
mv $GITHUB_WORKSPACE/build/tools/clang/docs/doxygen/html clang_doxygen/
git config --global user.name "iclsrc"
git config --global user.email "ia.compiler.tools.git@intel.com"
git add .
uditagarwal97 marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
1 change: 0 additions & 1 deletion buildbot/configure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,6 @@ def do_configure(args):
llvm_enable_assertions = "OFF"

if args.docs:
llvm_enable_doxygen = "ON"
llvm_enable_sphinx = "ON"

if args.shared_libs:
Expand Down
3 changes: 0 additions & 3 deletions sycl/doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Using oneAPI DPC++ for Application Development
Extensions <https://github.com/intel/llvm/tree/sycl/sycl/doc/extensions>
syclcompat/README.md
FAQ
User API Reference <https://intel.github.io/llvm-docs/doxygen/group__sycl__api.html>
EnvironmentVariables
MultiTileCardWithLevelZero
syclgraph/SYCLGraphUsageGuide
Expand All @@ -26,9 +25,7 @@ Design Documents for the oneAPI DPC++ Compiler
.. toctree::
:maxdepth: 1

API Reference <https://intel.github.io/llvm-docs/doxygen>
Clang Documentation <https://intel.github.io/llvm-docs/clang>
Clang API Reference <https://intel.github.io/llvm-docs/clang_doxygen>
design/CompilerAndRuntimeDesign
design/KernelParameterPassing
design/PluginInterface
Expand Down
Loading