documentation.yml

name: Documentation

on:
 push:
   branches:
     - develop
 pull_request:
 release:
     types: [published]


jobs:
  build:
    runs-on: ubuntu-latest
    strategy:
      max-parallel: 1
    env:
      HAS_SECRETS: ${{ secrets.AWS_SECRET_ACCESS_KEY != '' }}
    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.10
      uses: actions/setup-python@v5
      with:
        python-version: '3.10'
    - name: Install dependencies
      run: |
        sudo apt-get update
        sudo apt-get install -y --fix-missing libsqlite3-mod-spatialite libspatialite-dev pandoc latexmk texlive-latex-extra
        python -m pip install --upgrade pip
        pip install wheel openmatrix pytest
        pip install -r requirements.txt
        pip install -r docs/requirements-docs.txt
        

    - name: Compile library
      run: |
        python setup.py build_ext --inplace
        pip install .

    - name: Check history of versions
      run: |
          python docs/table_documentation.py
          python docs/create_docs_data.py
          python docs/website/check_documentation_versions.py

    - name: Test docstrings
      run: |
        python -m pytest --doctest-modules aequilibrae/log.py aequilibrae/parameters.py aequilibrae/paths/vdf.py
        python -m pytest docs/source/modeling_with_aequilibrae/project_pieces --doctest-glob=*.rst

    - name: Build documentation
      run: |
        jupyter nbconvert --to rst docs/source/useful_information/validation_benchmarking/IPF_benchmark.ipynb
        sphinx-build -M latexpdf docs/source docs/source/_static
        sphinx-build -b html docs/source docs/build
        python3 -m zipfile -c AequilibraE.zip docs/build
        cp AequilibraE.zip docs/source/_static
        cd docs
        make html

    - name: Upload to develop branch to S3
      if: ${{ (github.ref == 'refs/heads/develop') && (github.event_name == 'push') && (env.HAS_SECRETS == 'true') }}
      uses: jakejarvis/s3-sync-action@master
      with:
        args: --acl public-read --follow-symlinks --delete
      env:
        AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        AWS_REGION: 'us-east-1'   # optional: defaults to us-east-1
        SOURCE_DIR: 'docs/build/html/'      # optional: defaults to entire repository
        DEST_DIR: 'python/develop/'      # optional: defaults to entire repository

    - name: Upload to RELEASE on S3
      if: ${{ (github.event_name == 'release') && (env.HAS_SECRETS == 'true') }}
      uses: jakejarvis/s3-sync-action@master
      with:
        args: --acl public-read --follow-symlinks --delete
      env:
        AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        AWS_REGION: 'us-east-1'   # optional: defaults to us-east-1
        SOURCE_DIR: 'docs/build/html/'      # optional: defaults to entire repository
        DEST_DIR: 'python/latest/'      # optional: defaults to entire repository

    - name: Create Documentation history folder
      if: ${{ github.event_name == 'release'}}
      run: python docs/website/redir.py

    - name: Upload documentation to history folder
      if: ${{ (github.event_name == 'release') && (env.HAS_SECRETS == 'true') }}
      uses: jakejarvis/s3-sync-action@master
      with:
        args: --acl public-read --follow-symlinks --exclude '*.py'
      env:
        AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        AWS_REGION: 'us-east-1'   # optional: defaults to us-east-1
        SOURCE_DIR: 'docs/website/'      # optional: defaults to entire repository
        DEST_DIR: 'python/'      # optional: defaults to entire repository

    - name: Upload documentation to LATEST on AWS
      if: ${{ (github.event_name == 'release') && (env.HAS_SECRETS == 'true') }}
      uses: jakejarvis/s3-sync-action@master
      with:
        args: --acl public-read --follow-symlinks
      env:
        AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        AWS_REGION: 'us-east-1'   # optional: defaults to us-east-1
        SOURCE_DIR: 'docs/build/htmlv/'      # optional: defaults to entire repository
        DEST_DIR: 'python/'      # optional: defaults to entire repository

    - name: Rename documentation folder to push to S3 DEV
      if: ${{ (github.event_name == 'pull_request') && (env.HAS_SECRETS == 'true') }}
      run: mv docs/build/html/ docs/build/${{ github.event.number }}/

    - name: Upload to DEV on S3
      if: ${{ (github.event_name == 'pull_request') && (env.HAS_SECRETS == 'true') }}
      uses: jakejarvis/s3-sync-action@master
      with:
        args: --acl public-read --follow-symlinks --delete
      env:
        AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
        AWS_REGION: 'us-east-1'   # optional: defaults to us-east-1
        SOURCE_DIR: 'docs/build/'      # optional: defaults to entire repository
        DEST_DIR: 'python/dev/'      # optional: defaults to entire repository