[CI] Remove Doxygen docs from intel.github.io/llvm-docs/ #15482
Conversation
uditagarwal97
had a problem deploying
to
WindowsCILock
GitHub Actions
Error
uditagarwal97
changed the title
uditagarwal97
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
uditagarwal97
had a problem deploying
to
WindowsCILock
GitHub Actions
Error
uditagarwal97
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
uditagarwal97
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
| @@ -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 | |||
There was a problem hiding this comment.
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.
uditagarwal97
had a problem deploying
to
WindowsCILock
GitHub Actions
Error
uditagarwal97
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
uditagarwal97
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
uditagarwal97
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
uditagarwal97
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
uditagarwal97
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
uditagarwal97
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
uditagarwal97
had a problem deploying
to
WindowsCILock
GitHub Actions
Failure
uditagarwal97
temporarily deployed
to
WindowsCILock
GitHub Actions
Inactive
|
@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) |
Follow up of #15482 This PR enables hosting [intel.github.io/llvm-docs/ ](intel.github.io/llvm-docs/) website from intel/llvm. Generated docs will be uploaded as an artifact and will be used to host GH page (https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow). The new URL of the website will be **intel.github.io/llvm/** Example: https://uditagarwal97.github.io/llvm/
I've been regularly referencing the DPC++ Explicit SIMD API for my development work. Will this no longer be hosted anywhere? |
|
@uditagarwal97 @bader Can you guys please address Elliot's question? It looks like he was using the Doxygen. |
@elliottbinder @sarnex I'm afraid, no, we won't be hosting Doxygen docs anymore. |
|
@elliottbinder, could you provide more details about your use case? The Doxygen documentation intended to be used by DPC++ compiler developers, so we haven't considered other scenarios. |
|
I work in HPC research and appreciate any access to whatever features are available in the ISA of a CPU, GPU, or whatever processor. I'm leveraging the matrix acceleration instructions (DPAS/W) present on Intel GPUs for one project, and I've been using the ESIMD API to produce instructions that I want. This gives me access to instructions and functionality I'm not sure I'd be able to use otherwise (horizontal reduction, using different vector lengths and operations, block memory operations, register region addressing, cache hints). If you know of a different way to get this functionality without ESIMD, I'd be interested to know. Intel's Intrinsics Guide has been a reliable resource for CPUs for many years. If you take away this documentation for your GPUs, as far as I know how, I'd be stuck programming the GPU using a SIMT interface and don't get to leverage all the useful functionality that's already sitting there in silicon. In my experience, relying solely on compilers often leads to inefficient code, or having to write your code in a very specific way that may change if the underlying compiler heuristics change. It is simpler for folks in my line of work to just produce the instruction sequences we'd like directly. Do you know how the LinAlg/FFT/ML library teams are programming the GPUs? I'd expect to see similar approaches there as well. |
|
Hi @elliottbinder Thanks |
|
@asudarsa, based on the link @elliottbinder provided above, he uses Doxygen documentation generated from SYCL headers. That part has been removed from the hosted rendered version (it still can be generated locally though). We don't use Doxygen generated documentation for user faced API. This API is supposed to be documented in the extension specification. @elliottbinder, https://github.com/intel/llvm/tree/sycl/sycl/doc/extensions/supported/sycl_ext_intel_esimd should work for your use case. The Doxygen is built from sources, ESIMD headers can be used as well, although they are less readable than Doxygen generated webpages. |
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.