Skip to content

Commit

Permalink
modifies docs structure
Browse files Browse the repository at this point in the history
  • Loading branch information
r-akemii committed Nov 21, 2024
1 parent 83a127d commit 935b2d8
Show file tree
Hide file tree
Showing 173 changed files with 77 additions and 40 deletions.
53 changes: 45 additions & 8 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ jobs:
pip install wheel openmatrix pytest
pip install -r requirements.txt
pip install -r docs/requirements-docs.txt
- name: Compile library
run: |
Expand Down Expand Up @@ -65,7 +64,7 @@ jobs:
cd docs
make html
- name: Upload to develop branch to S3
- name: Upload to develop/python branch on S3
if: ${{ (github.ref == 'refs/heads/develop') && (github.event_name == 'push') && (env.HAS_SECRETS == 'true') }}
uses: jakejarvis/s3-sync-action@master
with:
Expand All @@ -75,10 +74,23 @@ jobs:
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
SOURCE_DIR: 'docs/build/html/python/' # optional: defaults to entire repository
DEST_DIR: 'develop/python/' # optional: defaults to entire repository

- name: Upload to RELEASE on S3
- name: Upload to develop/home branch 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
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/home.html' # optional: defaults to entire repository
DEST_DIR: 'develop/home.html' # optional: defaults to entire repository

- name: Upload to latest/python on S3
if: ${{ (github.event_name == 'release') && (env.HAS_SECRETS == 'true') }}
uses: jakejarvis/s3-sync-action@master
with:
Expand All @@ -88,9 +100,22 @@ jobs:
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
SOURCE_DIR: 'docs/build/html/python/' # optional: defaults to entire repository
DEST_DIR: 'latest/python/' # optional: defaults to entire repository

- name: Upload to latest/home 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/home.html' # optional: defaults to entire repository
DEST_DIR: 'latest/home.html' # optional: defaults to entire repository

- name: Create Documentation history folder
if: ${{ github.event_name == 'release'}}
run: python docs/website/redir.py
Expand Down Expand Up @@ -121,8 +146,20 @@ jobs:
SOURCE_DIR: 'docs/build/htmlv/' # optional: defaults to entire repository
DEST_DIR: 'latest/' # optional: defaults to entire repository

- name: Upload to dev/python 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/python' # optional: defaults to entire repository
DEST_DIR: 'test/${{ github.event.number }}/python' # optional: defaults to entire repository

- name: Upload to DEV on S3
- name: Upload to dev/home on S3
if: ${{ (github.event_name == 'pull_request') && (env.HAS_SECRETS == 'true') }}
uses: jakejarvis/s3-sync-action@master
with:
Expand All @@ -132,5 +169,5 @@ jobs:
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: 'dev/${{ github.event.number }}/python' # optional: defaults to entire repository
SOURCE_DIR: 'docs/build/html/home.html' # optional: defaults to entire repository
DEST_DIR: 'test/${{ github.event.number }}/home.html' # optional: defaults to entire repository
8 changes: 4 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ _build
_static
_templates
docs/source/sg_execution_times.rst
docs/source/_auto_examples
docs/source/api/generated
docs/source/modeling_with_aequilibrae/project_database/data_model
docs/source/modeling_with_aequilibrae/transit_database/data_model
docs/source/python/_auto_examples
docs/source/python/api/generated
docs/source/python/modeling_with_aequilibrae/project_database/data_model
docs/source/python/modeling_with_aequilibrae/transit_database/data_model

# User-specific stuff:
.idea/**/workspace.xml
Expand Down
14 changes: 7 additions & 7 deletions docs/source/_latex/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Examples
: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
../python/_auto_examples/creating_models/index
../python/_auto_examples/editing_networks/index
../python/_auto_examples/skimming/index
../python/_auto_examples/assignment_workflows/index
../python/_auto_examples/aequilibrae_without_a_model/index
../python/_auto_examples/visualization/index
../python/_auto_examples/other_applications/index
4 changes: 2 additions & 2 deletions docs/source/_latex/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ AequilibraE
:maxdepth: 1

examples
../modeling_with_aequilibrae/index
../api/api
../python/modeling_with_aequilibrae/index
../python/api/api
26 changes: 13 additions & 13 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,19 +72,19 @@

# Change plot_gallery to True to start building examples again
sphinx_gallery_conf = {
"examples_dirs": ["examples"], # path to your example scripts
"gallery_dirs": ["_auto_examples"], # path to where to save gallery generated output
"examples_dirs": ["python/examples"], # path to your example scripts
"gallery_dirs": ["python/_auto_examples"], # path to where to save gallery generated output
"capture_repr": ("_repr_html_", "__repr__"),
"remove_config_comments": True,
"subsection_order": ExplicitOrder(
[
"examples/creating_models",
"examples/editing_networks",
"examples/skimming",
"examples/assignment_workflows",
"examples/aequilibrae_without_a_model",
"examples/visualization",
"examples/other_applications",
"python/examples/creating_models",
"python/examples/editing_networks",
"python/examples/skimming",
"python/examples/assignment_workflows",
"python/examples/aequilibrae_without_a_model",
"python/examples/visualization",
"python/examples/other_applications",
]
),
"plot_gallery": True,
Expand All @@ -97,7 +97,7 @@
source_suffix = ".rst"

# The master toctree document.
master_doc = "python"
master_doc = "python/python"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -163,9 +163,9 @@
latex_documents = [("_latex/index", "aequilibrae.tex", html_title, author, "manual")]

latex_appendices = [
"useful_information/installation",
"useful_information/validation_benchmarking/ipf_performance",
"useful_information/validation_benchmarking/traffic_assignment",
"python/useful_information/installation",
"python/useful_information/validation_benchmarking/ipf_performance",
"python/useful_information/validation_benchmarking/traffic_assignment",
]

# -- Options for manual page output ------------------------------------------
Expand Down
12 changes: 6 additions & 6 deletions docs/source/home.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
AequilibraE
===========

.. image:: images/logos/banner.png
.. image:: python/images/logos/banner-transparent.png
:align: center

|
Expand All @@ -33,19 +33,19 @@ Please contact aequilibrae@outerloop.io for sponsoring opportunities.

<div style="display: flex; justify-content: center; gap: 20px;">

.. image:: images/logos/sponsor1.png
.. image:: python/images/logos/sponsor1.png
:target: https://www.outerloop.io

.. image:: images/logos/sponsor2.png
.. image:: python/images/logos/sponsor2.png
:target: https://www.ademe.fr

.. image:: images/logos/sponsor3.png
.. image:: python/images/logos/sponsor3.png
:target: https://lafabriquedesmobilites.fr/

.. image:: images/logos/sponsor4.png
.. image:: python/images/logos/sponsor4.png
:target: https://www.egis.fr/

.. image:: images/logos/sponsor5.png
.. image:: python/images/logos/sponsor5.png
:target: https://www.ipea.gov.br

.. raw:: html
Expand Down
File renamed without changes.
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 935b2d8

Please sign in to comment.