From 667b5ce3b4e22af9f7525b6f488092dc131e11ce Mon Sep 17 00:00:00 2001 From: Furkan Date: Sat, 16 Nov 2024 12:51:25 +0300 Subject: [PATCH] feat: add pdoc actions --- .github/workflows/pdoc.yml | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .github/workflows/pdoc.yml diff --git a/.github/workflows/pdoc.yml b/.github/workflows/pdoc.yml new file mode 100644 index 0000000..fc8bcf6 --- /dev/null +++ b/.github/workflows/pdoc.yml @@ -0,0 +1,35 @@ +name: Deploy Docs + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.x' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install pdoc3 + + - name: Generate documentation + run: | + cd src && pdoc3 --html --output-dir ../docs . + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs + publish_branch: gh-pages