Build integrated AequilibraE docs

.github/workflows/documentation.yml

@@ -74,7 +74,7 @@ jobs:
         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: 'dev/python/'      # optional: defaults to entire repository
+        DEST_DIR: 'dev/${{ github.event.number }}/python/'      # optional: defaults to entire repository
 
     - name: Upload home page to DEV on S3
       if: ${{ (github.event_name == 'pull_request') && (env.HAS_SECRETS == 'true') }}
@@ -87,32 +87,58 @@ jobs:
         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/'      # optional: defaults to entire repository
+        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
+        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: 'develop/python/'      # optional: defaults to entire repository
+
+    - 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 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
+        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: 'latest/python/'      # optional: defaults to entire repository
+
+    - 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 --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: 'latest/'      # optional: defaults to entire repository
 
     - name: Create Documentation history folder

docs/source/_templates/navigation_header.html

@@ -8,35 +8,35 @@
       <ul id="pst-nav-more-links" class="dropdown-menu" data-bs-popper="static">
         <li class=" ">
           <a class="nav-link dropdown-item nav-internal" 
-             href="https://www.aequilibrae.com/dev/python/index.html">
+             href="https://www.aequilibrae.com/latest/python/index.html">
              Main menu
           </a>
         </li>
         <li class=" ">
           <a class="nav-link dropdown-item nav-internal"
-            href="https://www.aequilibrae.com/dev/python/_auto_examples/index.html">
+            href="https://www.aequilibrae.com/latest/python/_auto_examples/index.html">
             Examples
           </a>
         </li>
         <li class=" ">
           <a class="nav-link dropdown-item nav-internal"
-            href="https://www.aequilibrae.com/dev/python/modeling_with_aequilibrae/index.html">
+            href="https://www.aequilibrae.com/latest/python/modeling_with_aequilibrae/index.html">
             Modeling with AequilibraE
           </a>
         </li>
         <li class=" ">
           <a class="nav-link dropdown-item nav-internal"
-            href="https://www.aequilibrae.com/dev/python/api.html">
+            href="https://www.aequilibrae.com/latest/python/api.html">
             API Reference
           </a>
         </li>
       </ul>
     </li>
     <li class="nav-item" id="index-nav-item" style="display: none;">
-      <a class="nav-link" href="https://www.aequilibrae.com/dev/python/index.html">Python</a>
+      <a class="nav-link" href="https://www.aequilibrae.com/latest/python/index.html">Python</a>
     </li>
     <li class="nav-item">
-      <a class="nav-link" href="https://www.aequilibrae.com/dev/qgis/index.html">QGIS</a>
+      <a class="nav-link" href="https://www.aequilibrae.com/latest/qgis/index.html">QGIS</a>
     </li>
   </ul>
 </nav>

docs/source/conf.py

@@ -143,7 +143,7 @@
         "text": "AequilibraE",
         "image_light": "_static/large_icon.png",
         "image_dark": "_static/large_icon.png",
-        "link": "https://www.aequilibrae.com/dev/home.html",
+        "link": "https://www.aequilibrae.com/latest/home.html",
     },
 }
 

docs/source/index.rst

@@ -47,7 +47,7 @@ Python
       Reference guide to AequilibraE's API.
 
    .. grid-item-card:: :material-outlined:`person;1.5em` Not a programmer?
-      :link: https://www.aequilibrae.com/dev/qgis/index.html
+      :link: https://www.aequilibrae.com/latest/qgis/index.html
       :text-align: center
 
       Take me to the GUI!

docs/source/modeling_with_aequilibrae/index.rst

@@ -7,7 +7,7 @@ other open-source packages in the Python (NumPy, really) ecosystem.
 
 AequilibraE has also a fully features interface available as a plugin for the
 open source software QGIS, which is separately maintained and discussed in
-detail its `documentation <http://www.aequilibrae.com/dev/qgis/index.html>`_.
+detail its `documentation <http://www.aequilibrae.com/latest/qgis/index.html>`_.
 
 Contributions are welcome to the existing modules and/or in the form of new modules.
 

docs/source/useful_information/development/softwaredevelopment.rst

@@ -72,7 +72,7 @@ Style
 ~~~~~
 
 * Python code should follow (mostly) the `pycodestyle style guide <https://pycodestyle.pycqa.org/en/latest/>`_
-* Python docstrings should follow the `reStructuredText Docstring Format <https://www.python.org/dev/peps/pep-0287/>`_
+* Python docstrings should follow the `reStructuredText Docstring Format <https://www.python.org/latest/peps/pep-0287/>`_
 * We are big fans of auto-code formatting. For that, we use `ruff <https://docs.astral.sh/ruff/>`_ and 
   `Black <https://black.readthedocs.io/en/stable/>`_.
 * Negating some of what we have said so far, we use maximum line length of 120 characters

docs/source/useful_information/version_history.rst

@@ -188,7 +188,7 @@ In the meantime, you can find the documentation for all versions since 0.5.3.
     .. grid-item::
 
     .. grid-item-card:: Upcoming version
-        :link:  https://aequilibrae.com/dev/python/index.html
+        :link:  https://aequilibrae.com/latest/python/index.html
         :link-type: url
         :text-align: center