docs-check.yml

name: "Docs check"
# https://github.com/marketplace/actions/sphinx-build

on:
  push: {}
  pull_request:
    branches: [main]

jobs:
  #  check-docs:
  #    runs-on: ubuntu-20.04
  #    steps:
  #    - uses: actions/checkout@v3
  #    - uses: ammaraskar/sphinx-action@master
  #      with:
  #        # git is required to clone the docs theme
  #        # before custom requirement are resolved https://github.com/ammaraskar/sphinx-action/issues/16
  #        pre-build-command: "apt-get update -y && apt-get install -y git && pip install -r requirements/docs.txt"
  #        docs-folder: "docs/"
  #        repo-token: "${{ secrets.GITHUB_TOKEN }}"

  test-docs:
    runs-on: ubuntu-20.04

    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: 3.8

      # Note: This uses an internal pip API and may not always work
      # https://github.com/actions/cache/blob/master/examples.md#multiple-oss-in-a-workflow
      - name: Cache pip
        uses: actions/cache@v3
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-

      - uses: aws-actions/configure-aws-credentials@v2
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_KEY_ID }}
          aws-region: us-east-1
      - run: aws s3 sync s3://sphinx-packages/ pypi/

      - name: Install dependencies
        run: |
          pip install  --requirement requirements.txt -U -f https://download.pytorch.org/whl/cpu/torch_stable.html -f pypi --quiet
          pip install  --requirement requirements/docs.txt -f pypi
          pip install -e .
          python --version ; pip --version ; pip list
        shell: bash

      - name: Test Documentation
        working-directory: ./docs
        env:
          SPHINX_MOCK_REQUIREMENTS: 0
        run: |
          # First run the same pipeline as Read-The-Docs
          apt-get update && sudo apt-get install -y cmake
          make doctest
          make coverage

  make-docs:
    runs-on: ubuntu-20.04

    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: 3.8

      # Note: This uses an internal pip API and may not always work
      # https://github.com/actions/cache/blob/master/examples.md#multiple-oss-in-a-workflow
      - name: Cache pip
        uses: actions/cache@v3
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
          restore-keys: |
            ${{ runner.os }}-pip-

      - uses: aws-actions/configure-aws-credentials@v2
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_KEY_ID }}
          aws-region: us-east-1
      - run: aws s3 sync s3://sphinx-packages/ pypi/

      - name: Install dependencies
        run: |
          pip install  --requirement requirements.txt -U -f https://download.pytorch.org/whl/torch_stable.html -f pypi  --quiet
          pip install  --requirement requirements/docs.txt -f pypi
          pip install -e .
          # install Texlive, see https://linuxconfig.org/how-to-install-latex-on-ubuntu-20-04-focal-fossa-linux
          sudo apt-get update
          sudo apt-get install -y texlive-latex-extra dvipng texlive-pictures
          python --version
          pip --version
          pip list
        shell: bash

      - name: Make Documentation
        working-directory: ./docs
        run: |
          # First run the same pipeline as Read-The-Docs
          make clean
          make html --debug --jobs 2 SPHINXOPTS="-W --keep-going"

      - name: Upload built docs
        uses: actions/upload-artifact@v3
        with:
          name: docs-results-${{ github.sha }}
          path: docs/build/html/
        if: success()