Build integrated AequilibraE docs

.github/workflows/documentation.yml

@@ -8,7 +8,6 @@ on:
  release:
      types: [published]
 
-
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -30,7 +29,6 @@ jobs:
         pip install wheel openmatrix pytest
         pip install -r requirements.txt
         pip install -r docs/requirements-docs.txt
-
 
     - name: Compile library
       run: |
@@ -57,78 +55,105 @@ jobs:
     - name: Build documentation
       run: |
         jupyter nbconvert --to rst docs/source/useful_information/validation_benchmarking/IPF_benchmark.ipynb
-        sphinx-build -b html docs/source docs/build
-        python3 -m zipfile -c AequilibraE.zip docs/build
+        sphinx-build -M latexpdf docs/source docs/source/_static -D plot_gallery=False
+        sphinx-build -D plot_gallery=False -b html docs/source docs/build
+        python -m zipfile -c AequilibraE.zip docs/build
         cp AequilibraE.zip docs/source/_static
+        cp large_icon.png docs/source/_static/large_icon.png
         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') }}
+    - name: Upload python 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
+        args: --acl public-read --follow-symlinks --delete --exclude 'home.html'
       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
+        DEST_DIR: 'dev/${{ github.event.number }}/python/'      # optional: defaults to entire repository
 
-    - name: Upload to RELEASE on S3
-      if: ${{ (github.event_name == 'release') && (env.HAS_SECRETS == 'true') }}
+    - name: Upload home page 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
+        args: --acl public-read --follow-symlinks --exclude '*' --include 'home.html' --include '_images/sponsor*' --include '_images/banner*' --include '_static/*' --include 'search*' --include 'genindex.html' --include '_sphinx_design_static/*'
+      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/'
+        DEST_DIR: 'dev/${{ github.event.number }}/'      # optional: defaults to entire repository
+
+    - name: Upload python to DEVELOP on 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 --exclude 'home.html'
       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
+        DEST_DIR: 'develop/python/'      # optional: defaults to entire repository
 
-    - name: Create Documentation history folder
-      if: ${{ github.event_name == 'release'}}
-      run: python docs/website/redir.py
+    - name: Upload home page to DEVELOP on 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 --exclude '*' --include 'home.html' --include '_images/sponsor*' --include '_images/banner*' --include '_static/*' --include 'search*' --include 'genindex.html' --include '_sphinx_design_static/*'
+      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/'
+        DEST_DIR: 'develop/'      # optional: defaults to entire repository
 
-    - name: Upload documentation to history folder
+    - name: Upload python to LATEST on S3
       if: ${{ (github.event_name == 'release') && (env.HAS_SECRETS == 'true') }}
       uses: jakejarvis/s3-sync-action@master
       with:
-        args: --acl public-read --follow-symlinks --exclude '*.py'
+        args: --acl public-read --follow-symlinks --delete --exclude 'home.html'
       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
+        SOURCE_DIR: 'docs/build/html/'      # optional: defaults to entire repository
+        DEST_DIR: 'latest/python/'      # optional: defaults to entire repository
 
-    - name: Upload documentation to LATEST on AWS
+    - name: Upload home page to LATEST on S3
       if: ${{ (github.event_name == 'release') && (env.HAS_SECRETS == 'true') }}
       uses: jakejarvis/s3-sync-action@master
       with:
-        args: --acl public-read --follow-symlinks
+        args: --acl public-read --follow-symlinks --exclude '*' --include 'home.html' --include '_images/sponsor*' --include '_images/banner*' --include '_static/*' --include 'search*' --include 'genindex.html' --include '_sphinx_design_static/*'
       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
+        SOURCE_DIR: 'docs/build/html/'
+        DEST_DIR: 'latest/'      # optional: defaults to entire repository
 
+    - name: Create Documentation history folder
+      if: ${{ github.event_name == 'release'}}
+      run: python docs/website/redir.py
 
-    - name: Upload to DEV on S3
-      if: ${{ (github.event_name == 'pull_request') && (env.HAS_SECRETS == 'true') }}
+    - 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 --delete
+        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/build/html/'      # optional: defaults to entire repository
-        DEST_DIR: 'python/dev/${{ github.event.number }}/'      # optional: defaults to entire repository
+        SOURCE_DIR: 'docs/website/'      # optional: defaults to entire repository
+        DEST_DIR: 'docs/python/'      # optional: defaults to entire repository

.gitignore

@@ -4,7 +4,7 @@ _static
 _templates
 docs/source/sg_execution_times.rst
 docs/source/_auto_examples
-docs/source/api/generated
+docs/source/_generated
 docs/source/modeling_with_aequilibrae/project_database/data_model
 docs/source/modeling_with_aequilibrae/transit_database/data_model
 
@@ -66,12 +66,11 @@ aequilibrae/**/*.pyd
 aequilibrae/**/*.c
 aequilibrae/**/*.html
 aequilibrae/**/build/*
-docs/build/*
-docs/source/_generated/*
-docs/source/project_database/*
-docs/source/_auto_examples/*
 *.cpp 
 
+# Build documentation
+docs/build/*
+docs/source/project_database/*
 
 #Virtual environment
 .venv/

docs/requirements-docs.txt

@@ -1,6 +1,6 @@
 enum34
 Sphinx
-pydata-sphinx-theme==0.13.3
+pydata-sphinx-theme
 sphinx_autodoc_annotation
 matplotlib
 folium

docs/source/_latex/examples.rst

@@ -0,0 +1,16 @@
+:orphan:
+
+Examples
+========
+
+.. toctree::
+    :hidden:
+    :maxdepth: 1
+
+    ../_auto_examples/creating_models/index
+    ../_auto_examples/editing_networks/index
+    ../_auto_examples/skimming/index
+    ../_auto_examples/assignment_workflows/index
+    ../_auto_examples/aequilibrae_without_a_model/index
+    ../_auto_examples/visualization/index
+    ../_auto_examples/other_applications/index

docs/source/_latex/index.rst

@@ -0,0 +1,12 @@
+:orphan:
+
+AequilibraE
+===========
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+
+   examples
+   ../modeling_with_aequilibrae/index
+   ../api

docs/source/_static/custom.css

@@ -1,7 +1,11 @@
+.bd-page-width {
+    max-width: 80%;
+}
+
 .bd-main .bd-content .bd-article-container {
-    max-width: 90%;
+    max-width: 80%;
 }
 
-.bd-page-width {
-    max-width: 90%;
-}
+.bd-links__title[role="heading"][aria-level="1"] {
+    display: none;
+}