Resource: turn about a joint, and the links and end-effectors that need it
#3843
Workflow file for this run
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: Build and Publish Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| tags: ['v*'] | |
| pull_request: | |
| branches: [main] | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: docs-deploy | |
| cancel-in-progress: false | |
| jobs: | |
| check_docs: | |
| name: Check documentation | |
| if: github.event_name == 'pull_request' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install Graphviz | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y graphviz | |
| - name: Install dependencies | |
| run: pip install -e '.[dev]' | |
| - name: Check documentation | |
| run: | | |
| rm -rf docs/build docs/_autosummary | |
| make docs | |
| deploy_docs: | |
| name: Build and deploy documentation | |
| if: github.event_name == 'push' | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install Graphviz | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y graphviz | |
| - name: Install dependencies | |
| run: pip install -e '.[dev]' | |
| - name: Determine version slug | |
| id: version | |
| run: | | |
| if [[ "$GITHUB_REF" == refs/tags/v* ]]; then | |
| echo "slug=${GITHUB_REF#refs/tags/v}" >> "$GITHUB_OUTPUT" | |
| else | |
| echo "slug=dev" >> "$GITHUB_OUTPUT" | |
| fi | |
| - name: Build documentation | |
| env: | |
| DOCS_VERSION: ${{ steps.version.outputs.slug }} | |
| run: | | |
| rm -rf docs/build docs/_autosummary | |
| make docs | |
| - name: Clean build artifacts | |
| run: rm -rf docs/build/.doctrees docs/build/.buildinfo | |
| - name: Deploy versioned docs | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/build | |
| destination_dir: ${{ steps.version.outputs.slug }} | |
| publish_branch: docs | |
| keep_files: true | |
| cname: docs.pylabrobot.org | |
| - name: Deploy stable | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/build | |
| destination_dir: stable | |
| publish_branch: docs | |
| keep_files: true | |
| cname: docs.pylabrobot.org |