Docs Versioning workflow (Farama-Foundation/Gymnasium-Robotics)

name: Docs Versioning

on:

  push:

    tags:

      - 'v?*.*.*'

permissions:

  contents: write

concurrency:

  group: ${{ github.workflow }}-${{ github.ref }}

  cancel-in-progress: true



jobs:

  docs:

    name: Generate Website for new version

    runs-on: latchkey-small

    env:

      SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}

    steps:

      - uses: actions/checkout@v7



      - uses: actions/setup-python@v6

        with:

          cache: 'pip'

            python-version: '3.10'



      - name: Get tag

        id: tag

        uses: dawidd6/action-get-tag@v1



      - name: Install docs requirements

        run: pip install -r docs/requirements.txt



      - name: Install requirements and Gymnasium-Robotics

        run: pip install -e .



      - name: Build Envs Docs

        run: python docs/_scripts/gen_mds.py



      - name: Build Envs Displays

        run: python docs/_scripts/gen_envs_display.py



      - name: Build

        run: sphinx-build -b dirhtml -v docs _build



      - name: Move 404

        run: mv _build/404/index.html _build/404.html



      - name: Update 404 links

        run: python docs/_scripts/move_404.py _build/404.html



      - name: Remove .doctrees

        run: rm -r _build/.doctrees



      - name: Upload to GitHub Pages

        uses: JamesIves/github-pages-deploy-action@v4

        with:

          folder: _build

          target-folder: ${{steps.tag.outputs.tag}}

          clean: false



      - name: Upload to GitHub Pages

        uses: JamesIves/github-pages-deploy-action@v4

        with:

          folder: _build

          clean-exclude: |

            *.*.*/

            main