[fbgemm_gpu] Save built docs as GHA artifact

- Save built docs as GHA artifact
pytorch · Feb 14, 2025 · eb5b096 · eb5b096
1 parent a4be13a
commit eb5b096
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 4 deletions.
diff --git a/.github/scripts/fbgemm_gpu_docs.bash b/.github/scripts/fbgemm_gpu_docs.bash
@@ -112,5 +112,8 @@ build_fbgemm_gpu_docs () {
   # shellcheck disable=SC2086
   (print_exec conda run ${env_prefix} make html) || return 1
 
+  # Package the docs for saving as GitHub actions artifact
+  (tar -cvzf docs.tar.gz build) || return 1
+
   echo "[DOCS] FBGEMM-GPU documentation build completed"
 }
diff --git a/.github/workflows/fbgemm_gpu_ci_cuda.yml b/.github/workflows/fbgemm_gpu_ci_cuda.yml
@@ -124,7 +124,6 @@ jobs:
       run: . $PRELUDE; cd fbgemm_gpu; build_fbgemm_gpu_package $BUILD_ENV nightly cuda
 
     - name: Upload Built Wheel as GHA Artifact
-      # Cannot upgrade to actions/upload-artifact@v4 yet because GLIBC on the instance is too old
       uses: actions/upload-artifact@v4
       with:
         name: fbgemm_gpu_nightly_cuda_${{ matrix.host-machine.arch }}_${{ matrix.compiler }}_py${{ matrix.python-version }}_cu${{ matrix.cuda-version }}.whl

diff --git a/.github/workflows/fbgemm_gpu_ci_genai.yml b/.github/workflows/fbgemm_gpu_ci_genai.yml
@@ -124,7 +124,6 @@ jobs:
       run: . $PRELUDE; cd fbgemm_gpu; build_fbgemm_gpu_package $BUILD_ENV nightly genai
 
     - name: Upload Built Wheel as GHA Artifact
-      # Cannot upgrade to actions/upload-artifact@v4 yet because GLIBC on the instance is too old
       uses: actions/upload-artifact@v4
       with:
         name: fbgemm_gpu_nightly_genai_${{ matrix.host-machine.arch }}_${{ matrix.compiler }}_py${{ matrix.python-version }}_cu${{ matrix.cuda-version }}.whl

diff --git a/.github/workflows/fbgemm_gpu_ci_genai_generic_infra.yml b/.github/workflows/fbgemm_gpu_ci_genai_generic_infra.yml
@@ -115,7 +115,6 @@ jobs:
       run: . $PRELUDE; cd fbgemm_gpu; build_fbgemm_gpu_package $BUILD_ENV nightly genai
 
     - name: Upload Built Wheel as GHA Artifact
-      # Cannot upgrade to actions/upload-artifact@v4 yet because GLIBC on the instance is too old
       uses: actions/upload-artifact@v4
       with:
         name: fbgemm_gpu_nightly_genai_${{ matrix.host-machine.arch }}_${{ matrix.compiler }}_py${{ matrix.python-version }}_cu${{ matrix.cuda-version }}.whl

diff --git a/.github/workflows/fbgemm_gpu_docs.yml b/.github/workflows/fbgemm_gpu_docs.yml
@@ -88,6 +88,13 @@ jobs:
     - name: Build FBGEMM_GPU Documentation
       run: . $PRELUDE; cd fbgemm_gpu/docs; build_fbgemm_gpu_docs $BUILD_ENV
 
+    - name: Upload Built Docs as GHA Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: fbgemm_gpu_docs_${{ github.sha }}.tar.gz
+        path: fbgemm_gpu/docs/docs.tar.gz
+        if-no-files-found: error
+
     - name: Deploy FBGEMM_GPU Documentation
       if: ${{ github.event_name != 'pull_request' }}
       uses: JamesIves/github-pages-deploy-action@releases/v4

diff --git a/fbgemm_gpu/docs/src/general/documentation/Python.rst b/fbgemm_gpu/docs/src/general/documentation/Python.rst
@@ -41,7 +41,7 @@ docstring:
       .. autofunction:: fbgemm_gpu.docs.examples.example_method
 
 #.  Make sure the ``.rst`` file is included in to the ``toctree`` in
-    ``index.rst`` (e.g. :ref:`fbgemm-gpu.toc.api.python`).
+    ``index.rst`` (e.g. :ref:`fbgemm-gpu.toc.api.python.ops`).
 
 #.  Verify the changes by building the docs locally with
     :ref:`general.docs.build` or submitting a PR for a Netlify preview.