From e1263c203166aab8f77cc40cbe2fcba6467d5713 Mon Sep 17 00:00:00 2001 From: Muhammad Shahbaz Date: Fri, 15 Nov 2024 06:09:15 -0500 Subject: [PATCH] created build_and_deploy_sphinx_docs.yml in add_easy_algo. --- .../build_and_deploy_sphinx_docs.yml | 52 +++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 .github/workflows/build_and_deploy_sphinx_docs.yml diff --git a/.github/workflows/build_and_deploy_sphinx_docs.yml b/.github/workflows/build_and_deploy_sphinx_docs.yml new file mode 100644 index 0000000..0d1c122 --- /dev/null +++ b/.github/workflows/build_and_deploy_sphinx_docs.yml @@ -0,0 +1,52 @@ +name: Docs + +on: + push: + branches: ["easy_add_algo"] + + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Install dependencies + run: | + pip install -r docs/sphinx/requirements.txt + + - name: Build HTML + run: | + cd docs/sphinx + sphinx-apidoc -o. ../../liguard + make html + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'docs/sphinx/_build/html' + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4