From fbf497bf9a9dbb960aeaf5423f091a1b5594ce5d Mon Sep 17 00:00:00 2001 From: Hari Date: Mon, 12 Feb 2024 11:46:30 +0100 Subject: [PATCH] added a workflow to update docs manually --- .github/workflows/publish-docs.yml | 33 ++++++++++++++++++++++++++++++ .github/workflows/test-main.yml | 2 +- 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/publish-docs.yml diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml new file mode 100644 index 0000000..d4130d4 --- /dev/null +++ b/.github/workflows/publish-docs.yml @@ -0,0 +1,33 @@ +name: Build and deploy documentation to GitHub Pages ๐Ÿ“ƒ + +on: + workflow_dispatch: + +jobs: + build: + name: Build and deploy documentation to GitHub Pages ๐Ÿ“ƒ + runs-on: ubuntu-latest + steps: + - name: Check out repository code + uses: actions/checkout@v4 + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: "3.8" + + - name: Upgrade pip + run: | + python -m pip install --upgrade pip + + - name: Build docs + run: | + pip install sphinx sphinx_rtd_theme recommonmark sphinx-autodoc-typehints sphinx-copybutton sphinx-prompt sphinx-notfound-page sphinx-autodoc-annotation + sphinx-build -b html docs/ ./public + cp -r docs/additional_resources/* ./public/ + + - name: Deploy docs + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./public \ No newline at end of file diff --git a/.github/workflows/test-main.yml b/.github/workflows/test-main.yml index 572b7f0..2551e73 100644 --- a/.github/workflows/test-main.yml +++ b/.github/workflows/test-main.yml @@ -1,4 +1,4 @@ -name: Test +name: Test main branch ๐Ÿงช on: push: