From 11d9dd02310b52e7d53bb81cf2c478f73f2e84c4 Mon Sep 17 00:00:00 2001 From: Abdalla1423 <77030779+Abdalla1423@users.noreply.github.com> Date: Wed, 5 Jun 2024 22:55:54 +0200 Subject: [PATCH 1/2] Create documentation.yml --- .github/workflows/documentation.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..4368110 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,27 @@ +name: documentation + +on: [push, pull_request, workflow_dispatch] + +permissions: + contents: write + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + - name: Install dependencies + run: | + pip install sphinx sphinx_rtd_theme myst_parser + - name: Sphinx build + run: | + sphinx-build -b html ./ _build/ + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} + with: + publish_branch: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: _build/ + force_orphan: true From a0e7ec2935dbc6098e73c4b889897dbbc8c8e1fd Mon Sep 17 00:00:00 2001 From: Abdalla1423 <77030779+Abdalla1423@users.noreply.github.com> Date: Wed, 5 Jun 2024 23:00:38 +0200 Subject: [PATCH 2/2] Update documentation.yml --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 4368110..f55e6a1 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -13,7 +13,7 @@ jobs: - uses: actions/setup-python@v5 - name: Install dependencies run: | - pip install sphinx sphinx_rtd_theme myst_parser + pip install sphinx sphinx_rtd_theme myst_parser numpydoc - name: Sphinx build run: | sphinx-build -b html ./ _build/