Merge pull request #5 from OpenQuantumDesign/docs #20
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 Mkdocs Documentation | |
| on: | |
| push: | |
| branches: ["main"] | |
| permissions: | |
| contents: write | |
| jobs: | |
| deploy_docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v4 | |
| - name: Configure Git Credentials | |
| run: | | |
| git config user.name github-actions[bot] | |
| git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
| - name: Install uv and set the python version | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| enable-cache: true | |
| - name: Retrieve Git submodules | |
| run: git submodule update --init --recursive && git submodule update --recursive --remote | |
| - name: Copy examples into docs folder | |
| run: cp -r examples/ docs/examples/ | |
| - name: Install repo | |
| run: uv sync --extra docs | |
| - name: Build docs | |
| run: uv run mkdocs gh-deploy --force |