update deploy action

Author: 9bow

.github/workflows/deploy-gh-pages.yml

@@ -15,10 +15,14 @@ env:
   PYPI_CACHE_DIR: "_pip-wheels"
 
 jobs:
-  build:
+  make-html:
     runs-on: ubuntu-latest
     container:
       image: pytorchlightning/pytorch_lightning:docs
+    strategy:
+      fail-fast: false
+      matrix:
+        pkg-name: ["app", "fabric", "pytorch"]
     steps:
       - uses: actions/checkout@v3
         with:
@@ -37,18 +41,47 @@ jobs:
           ls -lh $PYPI_CACHE_DIR
           mkdir -p pypi_pkgs  # in case template is not pulled
           pip --version
-          pip install -U -r requirements.txt \
-            -f pypi_pkgs/ -f $PYPI_CACHE_DIR -f ${TORCH_URL}
-          pip install -U -r requirements/docs.txt \
+          pip install -U -r requirements/${{ matrix.pkg-name }}/docs.txt \
             -f pypi_pkgs/ -f $PYPI_CACHE_DIR -f ${TORCH_URL}
           pip list
         shell: bash
 
-      - name: Build Sphinx documents
-        run: |
-          git config --global --add safe.directory /
-          make docs
+      - name: Make Documentation
+        working-directory: ./docs/source-${{ matrix.pkg-name }}
+        run: make html --debug --jobs $(nproc) SPHINXOPTS="-W --keep-going"
+
+      - name: Keep artifact
+        id: keep-artifact
+        run: python -c "print('DAYS=' + str(7 if '${{ github.event_name }}'.startswith('pull_request') else 0))" >> $GITHUB_OUTPUT
+
+      - name: Upload built docs
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs-${{ matrix.pkg-name }}-${{ github.sha }}
+          path: docs/build/html/
+          retention-days: ${{ steps.keep-artifact.outputs.DAYS }}
 
+      - name: Dump handy wheels
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        continue-on-error: true
+        uses: ./.github/actions/pip-wheels
+        with:
+          wheel-dir: ${{ env.PYPI_CACHE_DIR }}
+          torch-url: ${{ env.TORCH_URL }}
+          cache-key: "pypi_wheels"
+
+  deploy-docs:
+    needs: [make-html]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        pkg-name: ["app", "fabric", "pytorch"]
+    steps:
+      - uses: actions/download-artifact@v3
+        with:
+          name: docs-${{ matrix.pkg-name }}-${{ github.sha }}
+          path: docs/build/html/
       - name: Deploy to gh-pages branch
         uses: peaceiris/actions-gh-pages@v3
         with:

Makefile

@@ -32,7 +32,7 @@ docs:
 	pip install -qq lightning # install (stable) Lightning from PyPI instead of src
 	pip install -qq -r requirements/app/base.txt
 	pip install -qq -r requirements/pytorch/docs.txt
-	cd docs/source-pytorch && $(MAKE) html --jobs $(nproc)
+	cd docs/source-pytorch && $(MAKE) html --jobs $(nproc) && cd ../../
 
 update:
 	git submodule update --init --recursive --remote

docs/source-app/conf.py

@@ -16,7 +16,7 @@
 import shutil
 import sys
 
-import lai_sphinx_theme
+# import lai_sphinx_theme
 from lightning_utilities.docs import fetch_external_assets
 
 import lightning
@@ -82,7 +82,7 @@
     "sphinx_paramlinks",
     "sphinx_togglebutton",
     "sphinx.ext.githubpages",
-    "lai_sphinx_theme.extensions.lightning",
+    # "lai_sphinx_theme.extensions.lightning",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -144,7 +144,8 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "lai_sphinx_theme"
+# html_theme = "lai_sphinx_theme"
+html_theme = "pt_lightning_sphinx_theme"
 html_theme_path = [os.environ.get('LIT_SPHINX_PATH', lai_sphinx_theme.get_html_theme_path())]
 
 # Theme options are theme-specific and customize the look and feel of a theme

requirements.txt

@@ -1,3 +1,6 @@
+# instead of install from source, use the pre-built wheel
+lightning
+
 # the default package dependencies
 -r ./requirements/app/base.txt
 -r ./requirements/pytorch/base.txt

requirements/app/docs.txt

@@ -1,3 +1,5 @@
 -r ../docs.txt
 
-lai-sphinx-theme
+# lai-sphinx-theme is not installable
+# refer: https://github.com/Lightning-AI/lightning/issues/16158
+# lai-sphinx-theme

requirements/pytorch/docs.txt

@@ -6,6 +6,6 @@ ipython[notebook]==8.10
 setuptools==65.5.1
 
 # pt-lightning-sphinx-theme @ https://github.com/Lightning-AI/lightning_sphinx_theme/archive/master.zip
-pt-lightning-sphinx-theme @ https://github.com/PyTorchKorea/lightning_sphinx_theme/archive/master.zip
+pt-lightning-sphinx-theme@https://github.com/PyTorchKorea/lightning_sphinx_theme/archive/master.zip
 
 -r ../../_notebooks/.actions/requires.txt