doc: how to realign a branch with origin #21
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
| # You need to enable github to host your pages. | |
| # github.com > Settings > Pages > Build and deployment: | |
| # > Source > Deploy from a branches | |
| # > Branch > gh-pages / `/root` | |
| name: Deploy docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - master | |
| paths: | |
| - "**.md" | |
| - "mkdocs.yml" | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }} | |
| cancel-in-progress: true | |
| jobs: | |
| docs: | |
| # Create latest docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Setup doc deploy | |
| run: | | |
| git config user.name 'github-actions[bot]' | |
| git config user.email 'github-actions[bot]@users.noreply.github.com' | |
| - name: Deploy docs | |
| uses: mhausenblas/mkdocs-deploy-gh-pages@master | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| REQUIREMENTS: docs/requirements.txt |