initial commit #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Auto-deployment of Documentation | |
on: | |
push: | |
branches: [ main ] | |
jobs: | |
build-docs: | |
permissions: | |
contents: write | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/[email protected] | |
with: | |
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo | |
- name: Set up Python 3. | |
uses: actions/setup-python@v3 | |
with: | |
python-version: 3.11 | |
- name: Install Poetry. | |
uses: snok/[email protected] | |
- name: Install dependencies. | |
run: | | |
poetry install | |
#---------------------------------------------- | |
# Create documentation and deploy. | |
#---------------------------------------------- | |
- name: Create local docs | |
run: | | |
touch docs/.nojekyll | |
poetry run mkdocs gh-deploy |