From 060e076dd9739d760570e5028e8d5e2265510d9a Mon Sep 17 00:00:00 2001 From: r3yc0n1c Date: Wed, 15 Jan 2025 01:20:08 +0530 Subject: [PATCH 1/5] Add GitHub Actions workflow for documentation deployment --- .github/workflows/deploy.yml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/workflows/deploy.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 000000000..9f644984e --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,31 @@ +name: Deploy Sphinx Documentation to GitHub Pages + +on: + push: + branches: + - main # Adjust this to your default branch + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - name: Check out the repository + uses: actions/checkout@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: '3.9' + + - name: Install dependencies + run: pip install sphinx sphinx-rtd-theme + + - name: Build documentation + run: make html + working-directory: docs # Adjust to your Sphinx docs directory + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/_build/html \ No newline at end of file From d02b6c01b741648429a53009d26c80b63d56be10 Mon Sep 17 00:00:00 2001 From: r3yc0n1c Date: Wed, 15 Jan 2025 01:35:13 +0530 Subject: [PATCH 2/5] fix: gitHub cctions workflow for doc deployment --- .github/workflows/deploy.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 9f644984e..3f9a0c531 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -22,10 +22,10 @@ jobs: - name: Build documentation run: make html - working-directory: docs # Adjust to your Sphinx docs directory + working-directory: doc # Adjust to your Sphinx docs directory - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: docs/_build/html \ No newline at end of file + publish_dir: doc/_build/html \ No newline at end of file From f52f551f95ef38bd36e52170e684c36aef37907b Mon Sep 17 00:00:00 2001 From: r3yc0n1c Date: Wed, 15 Jan 2025 01:49:05 +0530 Subject: [PATCH 3/5] fix: pip deps issue in gh actions workflow for doc deployment --- .github/workflows/deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 3f9a0c531..1d60810b5 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -18,7 +18,7 @@ jobs: python-version: '3.9' - name: Install dependencies - run: pip install sphinx sphinx-rtd-theme + run: pip install --upgrade-strategy eager -Ur doc/requirements.txt - name: Build documentation run: make html From a1eb5bbc4cf69a6e13de23269ce667dfdc378002 Mon Sep 17 00:00:00 2001 From: r3yc0n1c Date: Wed, 15 Jan 2025 01:51:30 +0530 Subject: [PATCH 4/5] fix: py version deps mismatch in gh actions workflow for doc deployment --- .github/workflows/deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 1d60810b5..671d011f9 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -15,7 +15,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v4 with: - python-version: '3.9' + python-version: '3.11' - name: Install dependencies run: pip install --upgrade-strategy eager -Ur doc/requirements.txt From a077f1c342349828e608e323bd2c3ab7ca977278 Mon Sep 17 00:00:00 2001 From: r3yc0n1c Date: Wed, 15 Jan 2025 21:55:53 +0530 Subject: [PATCH 5/5] add GitHub Actions workflow for documentation deployment --- .github/workflows/deploy.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 671d011f9..fdeb2d2d0 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -16,6 +16,9 @@ jobs: uses: actions/setup-python@v4 with: python-version: '3.11' + + - name: Install system packages + run: sudo apt update && sudo apt install libffi-dev gettext - name: Install dependencies run: pip install --upgrade-strategy eager -Ur doc/requirements.txt