[all-commits] [llvm/llvm-project] cea333: [Offload] Add Offload API Sphinx documentation (#1...

Kenneth Benzie (Benie) via All-commits all-commits at lists.llvm.org
Thu Jul 10 03:51:13 PDT 2025


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: cea33304c0ea7fdcd40c7ad6cfeef813d3c9f5e5
      https://github.com/llvm/llvm-project/commit/cea33304c0ea7fdcd40c7ad6cfeef813d3c9f5e5
  Author: Kenneth Benzie (Benie) <k.benzie83 at gmail.com>
  Date:   2025-07-10 (Thu, 10 Jul 2025)

  Changed paths:
    M offload/CMakeLists.txt
    A offload/docs/.gitignore
    A offload/docs/CMakeLists.txt
    A offload/docs/conf.py
    A offload/docs/index.rst
    M offload/liboffload/API/Common.td
    M offload/tools/offload-tblgen/APIGen.cpp
    M offload/tools/offload-tblgen/CMakeLists.txt
    A offload/tools/offload-tblgen/DocGen.cpp
    M offload/tools/offload-tblgen/GenCommon.hpp
    M offload/tools/offload-tblgen/Generators.hpp
    M offload/tools/offload-tblgen/offload-tblgen.cpp

  Log Message:
  -----------
  [Offload] Add Offload API Sphinx documentation (#147323)

* Add spec generation to offload-tblgen tool
* This patch adds generation of Sphinx compatible reStructuedText
utilizing the C domain to document the Offload API directly from the
spec definition `.td` files.
* Add Sphinx HTML documentation target
* Introduces the `docs-offload-html` target when CMake is configured
with `LLVM_ENABLE_SPHINX=ON` and `SPHINX_OUTPUT_HTML=ON`. Utilized
`offload-tblgen -gen-spen` to generate Offload API specification docs.



To unsubscribe from these emails, change your notification settings at https://github.com/llvm/llvm-project/settings/notifications


More information about the All-commits mailing list