docs.yaml

name: Build documentation

on:
  pull_request:
    branches:
      - develop
      - master

jobs:
  documentation:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repo
      uses: actions/checkout@v2
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v2
      with:
        python-version: '3.9'

    - name: Install dependencies
      run: |
        sudo apt-get install -y libreoffice djvulibre-bin poppler-utils
        python -m pip install --upgrade --no-cache-dir pip setuptools
        python -m pip install --exists-action=w --no-cache-dir -r requirements.txt
        python -m pip install --upgrade --upgrade-strategy eager --no-cache-dir .[torch,docs]

    - name: Build documentation
      # Build the documentation, you can use this command locally
      run: |
        python -m sphinx -T -E -W -b html -d docs/_build/doctrees -D language=en docs/source docs/_build
        cd docs/source/_static/code_examples
        python dedoc_usage_tutorial.py
        python dedoc_add_new_doc_type_tutorial.py