diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..8bc2c34 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,30 @@ +name: Deploy documentation site + +on: + push: + paths: + - 'docs/**' + - '.github/workflows/deploy-docs.yml' + workflow_dispatch: + +jobs: + build: + name: Deploys + runs-on: ubuntu-latest + steps: + - name: 'Checkout GitHub Action' + uses: actions/checkout@main + + - name: 'Build and deploy' + shell: bash + run: | + brew install doctave/doctave/doctave + doctave build --release --allow-failed-checks + + - name: GitHub Pages + if: github.ref == 'refs/heads/main' + uses: crazy-max/ghaction-github-pages@v4 + with: + build_dir: site/ + env: + GITHUB_TOKEN: {{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 1000b80..f4820e4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -107,7 +107,7 @@ class Product(models.Model): - [django-easy-audit](https://github.com/soynatan/django-easy-audit) - [django-extensions](https://github.com/django-extensions/django-extensions) - [nplusone](https://github.com/jmcarp/nplusone) -- [django-debug-toolbar](https://) +- django-debug-toolbar ## Packages to consider