[CI] Update sphinx_build script (#175)

cornell-zhang · Sep 8, 2024 · b816d40 · b816d40
1 parent 1e76376
commit b816d40
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 6 deletions.
diff --git a/.github/workflows/sphinx_build.yml b/.github/workflows/sphinx_build.yml
@@ -60,19 +60,30 @@ jobs:
         cd docs
         python3 -m pip install -r requirements.txt
         make html
+    - run: touch docs/build/html/.nojekyll
     # Create an artifact of the html output using Github action: https://github.com/actions/upload-artifact
     - uses: actions/upload-artifact@v1
       with:
         name: DocumentationHTML
         path: docs/build/html/
-    - name: Install rsync
-      run: |
-        apt-get update && apt-get install -y rsync
-    - run: touch docs/build/html/.nojekyll
+
+  deploy:
+    # https://github.com/JamesIves/github-pages-deploy-action?tab=readme-ov-file#operating-system-support-
+    concurrency: ci-${{ github.ref }}
+    # Create a separate job that does not use the docker container
+    runs-on: ubuntu-latest
+    needs: [build]
+    steps:
+    - name: Checkout 🛎️
+      uses: actions/checkout@v4
+    - name: Download Artifacts 🔻 # The built project is downloaded into the 'DocumentationHTML' folder.
+      uses: actions/download-artifact@v1
+      with:
+        name: DocumentationHTML
     - name: Deploy docs
       uses: JamesIves/github-pages-deploy-action@releases/v3
       if: github.event_name == 'push'
       with:
         ACCESS_TOKEN: ${{ secrets.DEPLOY_ACCESS_TOKEN }}
         BRANCH: gh-pages
-        FOLDER: docs/build/html
+        FOLDER: 'DocumentationHTML'
diff --git a/docs/source/setup/index.rst b/docs/source/setup/index.rst
@@ -27,7 +27,7 @@ Installation
 To install and use Allo, we need to have the LLVM compiler infrastructure installed on our system.
 We have already prepared a prebuilt version of LLVM on our server, so you can directly export it to your system path.
 Please follow the instruction below to set up the environment.
-If you want to install Allo on your local machine, you can refer to the [README](https://github.com/cornell-zhang/allo) guideline in the Allo repository.
+If you want to install Allo on your local machine, you can refer to the `README <https://github.com/cornell-zhang/allo>`_ guideline in the Allo repository.
 
 Make sure you have the access to the :code:`brg-zhang` or other Zhang group server. You can log into the server by
 SSH or use VSCode Remote SSH extension. Please refer to `this website <https://code.visualstudio.com/docs/remote/ssh>`_