test_docs.yml

name: Documentation Build & Deploy

# Controls when the action will run.
on: [push, pull_request, workflow_dispatch]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@a37ce9120846195fa4ece8f58b268e6043cb2f26 # v3.7.0

      - name: Setup Python
        uses: actions/setup-python@7f4fc3e22c37d6ff65e88745f38bd3157c663f7c # v4.9.1
        with:
          python-version: '3.7'
          architecture: 'x64'

      - name: Install dependencies
        run: |
          python3 -m pip install --upgrade pip
          python3 -m pip install mkdocs pymdown-extensions    # Mkdocs requirements
          
      - name: Build API reference docs
        run: |
          python3 -m venv .env                            # Virtual env to avoid dep. issues 
          source .env/bin/activate
          pip install Sphinx sphinx_rtd_theme numpy msgpack-rpc-python

          pushd PythonClient >/dev/null
          ./build_api_docs.sh
          popd >/dev/null
          cp -r PythonClient/docs/_build docs/api_docs/   # Copy generated files

          deactivate

      - name: Build AirSim Documentation
        run: ./build_docs.sh

      # Only on commits to 'main' branch
      - name: Deploy
        uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3
        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./build_docs