fix: avoid installing sphinx-autoapi branch in pyproject.toml (#21)

Co-authored-by: Revathyvenugopal162 <[email protected]>

Author: jorgepiloto

.github/workflows/ci.yml

@@ -43,10 +43,55 @@ jobs:
     runs-on: ubuntu-latest
     needs: [doc-style]
     steps:
-      - uses: ansys/actions/doc-build@v4
+
+      - name: "Checkout project"
+        uses: actions/checkout@v4
+
+      - name: "Install Python"
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
+      - name: "Install project with doc dependencies"
+        run: |
+          sudo apt update
+          sudo apt-get install -y build-essential texlive-latex-extra latexmk texlive-pstricks
+          python -m pip install .[doc]
+
+      - name: "Install custom sphinx-autoapi branch"
+        run: |
+          python -m pip install \
+            "sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi@feat/single-page-stable"
+
+      - name: "Build HTML documentation"
+        run: |
+          make -C doc html
+
+      - name: "Build PDF documentation"
+        run: |
+          make -C doc pdf
+
+      - name: "Upload HTML documentation artifact"
+        uses: actions/upload-artifact@v3
+        with:
+          name: documentation-html
+          path: doc/_build/html
+          retention-days: 7
+
+      - name: "Upload PDF documentation artifact"
+        uses: actions/upload-artifact@v3
+        with:
+          name: documentation-pdf
+          path: doc/_build/latex/*.pdf
+          retention-days: 7
+
+      # TODO: restore these step in favor of previous ones this PR is merged
+      # https://github.com/readthedocs/sphinx-autoapi/pull/399
+      #
+      # - uses: ansys/actions/doc-build@v4
+      #   with:
+      #     python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
   build-wheelhouse:
     name: "Build wheelhouse for latest Python versions"
     runs-on: ${{ matrix.os }}

pyproject.toml

@@ -41,7 +41,9 @@ doc = [
     "myst-parser==2.0.0",
     "numpydoc==1.5.0",
     "Sphinx==7.2.5",
-    "sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi@feat/single-page-stable",
+    # TODO: use the following for local development until merged into sphinx-autoapi
+    # "sphinx-autoapi @ git+https://github.com/ansys/sphinx-autoapi@feat/single-page-stable",
+    "sphinx-autoapi==3.0.0",
     "sphinx-autodoc-typehints==1.24.0",
     "sphinx-copybutton==0.5.2",
     "sphinx_design==0.5.0",