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.

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

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

Merged
merged 5 commits into from
Sep 25, 2024

Conversation

uditagarwal97
Copy link
Contributor

@uditagarwal97 uditagarwal97 commented Sep 24, 2024

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 repository will soon be decommissioned.

@uditagarwal97 uditagarwal97 self-assigned this Sep 24, 2024
@uditagarwal97 uditagarwal97 changed the title [CI] Remove Doxygen docs from intel.github.io [CI] Remove Doxygen docs from intel.github.io/llvm-docs/ Sep 24, 2024
@@ -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
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.

Copy link
Contributor

@sarnex sarnex left a comment

Choose a reason for hiding this comment

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

esimd lgtm

@sarnex sarnex requested a review from a team September 24, 2024 15:11
.github/workflows/sycl-docs.yml Show resolved Hide resolved
@uditagarwal97
Copy link
Contributor Author

@intel/llvm-gatekeepers the PR is ready for merge. E2E test failures are unrelated and also reported in other PRs (like https://github.com/intel/llvm/actions/runs/11018636840/job/30604700124)

@bader bader merged commit 5e9f4c8 into sycl Sep 25, 2024
20 of 22 checks passed
@bader bader deleted the sycl-devops-pr/udit/remove-doxy branch September 25, 2024 00:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants