diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 189b9acf..a5e73534 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -6,14 +6,14 @@ on: paths-ignore: - "tests/**" - "third_party/**" - - "README.md" + - "*.md" branches: - main push: paths-ignore: - "tests/**" - "third_party/**" - - "README.md" + - "*.md" branches: - main @@ -26,9 +26,8 @@ jobs: strategy: fail-fast: false matrix: - os: [ "ubuntu-latest" ] python-version: [ "3.10" ] - runs-on: "${{ matrix.os }}" + runs-on: ubuntu-latest defaults: run: shell: bash -el {0} @@ -52,6 +51,8 @@ jobs: - name: Build docs run: | + set -x + sudo apt update && sudo apt install -yqq doxygen conda install -c file://${HOME}/package/ spdl conda install -c conda-forge 'ffmpeg==6' pip install -r docs/requirements.txt diff --git a/docs/build.sh b/docs/build.sh index 56fb1285..a02f62dd 100755 --- a/docs/build.sh +++ b/docs/build.sh @@ -8,7 +8,8 @@ set -eux cd "$(dirname "$0")" -rm -rf _build source/generated + +find source/generated ! -name 'libspdl_*.rst' -type f -exec rm -f {} + mkdir -p _build/breathe/doxygen/libspdl/xml/ diff --git a/docs/requirements.txt b/docs/requirements.txt index abd9c11a..ba7a4b69 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,6 @@ furo==2024.7.18 sphinx==7.4.7 sphinxcontrib-mermaid==0.9.2 -# # C++ -# breathe -# exhale +breathe +exhale diff --git a/docs/source/api.rst b/docs/source/api.rst index d6de4d36..61f510ae 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -10,7 +10,3 @@ API Reference spdl.io spdl.dataloader spdl.utils - -.. toctree:: - - generated/libspdl/root diff --git a/docs/source/conf.py b/docs/source/conf.py index 279760e6..dd8bfd40 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -33,8 +33,8 @@ "sphinx.ext.linkcode", "sphinx.ext.napoleon", "sphinxcontrib.mermaid", - # "breathe", - # "exhale", + "breathe", + "exhale", ] autosummary_generate = True autosummary_imported_members = True diff --git a/docs/source/cpp.rst b/docs/source/cpp.rst new file mode 100644 index 00000000..91f63ac6 --- /dev/null +++ b/docs/source/cpp.rst @@ -0,0 +1,9 @@ +API References (C++) +==================== + +.. toctree:: + :caption: API References (C++) + + Class List + File List + API diff --git a/docs/source/generated/libspdl/libspdl_api.rst b/docs/source/generated/libspdl/libspdl_api.rst new file mode 100644 index 00000000..adc4091f --- /dev/null +++ b/docs/source/generated/libspdl/libspdl_api.rst @@ -0,0 +1 @@ +.. include:: unabridged_api.rst.include diff --git a/docs/source/generated/libspdl/libspdl_class.rst b/docs/source/generated/libspdl/libspdl_class.rst new file mode 100644 index 00000000..e4132962 --- /dev/null +++ b/docs/source/generated/libspdl/libspdl_class.rst @@ -0,0 +1 @@ +.. include:: class_view_hierarchy.rst.include diff --git a/docs/source/generated/libspdl/libspdl_file.rst b/docs/source/generated/libspdl/libspdl_file.rst new file mode 100644 index 00000000..fb87cf09 --- /dev/null +++ b/docs/source/generated/libspdl/libspdl_file.rst @@ -0,0 +1 @@ +.. include:: file_view_hierarchy.rst.include diff --git a/docs/source/index.rst b/docs/source/index.rst index 5398e893..f1af5ef8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -32,6 +32,7 @@ SPDL (Scalable and Performant Data Loading) :caption: API References API Reference + API Reference (C++) API Reference (Meta) API Index