Add C++ docs

facebookresearch · Sep 4, 2024 · d40b458 · d40b458
1 parent 0d1a6d0
commit d40b458
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 14 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -0,0 +1,9 @@
+API References (C++)
+====================
+
+.. toctree::
+   :caption: API References (C++)
+
+   Class List <generated/libspdl/libspdl_class>
+   File List <generated/libspdl/libspdl_file>
+   API <generated/libspdl/libspdl_api>
diff --git a/docs/source/generated/libspdl/libspdl_api.rst 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
@@ -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
@@ -0,0 +1 @@
+.. include:: file_view_hierarchy.rst.include
diff --git 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>
+   API Reference (C++) <cpp>
    API Reference (Meta) <fb/api>
    API Index <genindex>