docs: add README.md file #2
This file contains hidden or 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: Deploy Documentation | |
| on: | |
| push: | |
| branches: [ main ] | |
| paths: | |
| - 'docs/**' | |
| - 'README.md' | |
| - 'mkdocs.yml' | |
| - 'build-scripts/build-docs.sh' | |
| - 'build-scripts/deploy-docs.sh' | |
| workflow_dispatch: | |
| jobs: | |
| deploy-docs: | |
| name: Deploy Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Install MkDocs | |
| run: pip install mkdocs==1.6.1 mkdocs-material==9.7.6 pymdown-extensions==10.21.2 pygments==2.20.0 | |
| - name: Build documentation | |
| run: bash build-scripts/build-docs.sh | |
| - name: Deploy to server | |
| env: | |
| DEPLOY_SSH_KEY: ${{ secrets.DEPLOY_SSH_KEY }} | |
| DEPLOY_HOST_KEY: ${{ secrets.DEPLOY_HOST_KEY }} | |
| DEPLOY_HOST: ${{ secrets.DEPLOY_HOST }} | |
| DEPLOY_USER: ${{ secrets.DEPLOY_USER }} | |
| DEPLOY_DOC_PATH: ${{ secrets.DEPLOY_DOC_PATH }} | |
| run: bash build-scripts/deploy-docs.sh |