diff --git a/.github/workflows/docs b/.github/workflows/docs new file mode 100644 index 0000000..63853ca --- /dev/null +++ b/.github/workflows/docs @@ -0,0 +1,27 @@ +name: Documents +on: [push, pull_request, workflow_dispatch] +permissions: + contents: write +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v3 + - name: Install dependencies + run: | + pip install sphinx sphinx_rtd_theme recommonmark + - name: API + run: | + sphinx-apidoc ../pyautomail -o api -H "API Rrf." -Mf --tocfile index --templatedir ./_templates/apidoc -d 2 + - name: Sphinx build + run: | + sphinx-build docs _build + - name: Deploy + 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