PT preloading implementation #1574
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| pull_request: | |
| release: | |
| 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.9 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.9 | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install wheel openmatrix | |
| pip install -r requirements.txt | |
| pip install -r requirements_additional.txt | |
| pip install -r docs/requirements-docs.txt | |
| sudo apt update | |
| sudo apt install -y --fix-missing libsqlite3-mod-spatialite libspatialite-dev pandoc | |
| sudo ln -s /usr/lib/x86_64-linux-gnu/mod_spatialite.so /usr/lib/x86_64-linux-gnu/mod_spatialite | |
| sudo apt install latexmk | |
| sudo apt install texlive-latex-extra | |
| - 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: | | |
| echo "DOCUMENTATION TESTING GOES HERE" | |
| python -m doctest -v ./aequilibrae/parameters.py | |
| python -m doctest -v ./aequilibrae/project/about.py | |
| python -m doctest -v ./aequilibrae/project/zoning.py | |
| - name: Build documentation | |
| run: | | |
| 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 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/html/' # optional: defaults to entire repository | |
| DEST_DIR: 'python/dev/' # optional: defaults to entire repository | |
| - 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 |