New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Renata/docs #563

Merged

r-akemii merged 62 commits into develop from renata/docs

Sep 18, 2024

Collaborator

r-akemii commented Aug 16, 2024 •

edited

Loading

This PR aims to improve AequilibraE's documentation (especially for beginners). Major modifications were made to the documentation structure, as we moved some contents across files.

Modifications in this PR include:

Addition of a basics on AequilibraE project contents and AequilibraE matrix;
Changed the presentation of the per-table view for network and public transport tables;
Fixed the example's rendering;
Added references and see also tags to the examples;
Changed the reference caller for some external web pages;
Added new files to .gitignore;
Fixed small typos;
Removed geopandas from the examples

r-akemii and others added 24 commits

August 16, 2024 10:12


          docs

683dd31


          split network file

556bc2c


          updates conf file

56fa117


          docs

46d608a


          route choice model docs

24b8a72

2d38c12


          Update route_choice.py

c2a49c7


          Merge branch 'develop' into renata/docs

790dd31


          docs

72a93b0

2821f79

ae6f105


          change folder structure

ea16285

e28dbc1

70d710d

abbbb64


          rename folders

3c304c8


          linting

0a582da


          rename files

87ec3ca

b8710a3

949c441

3236cf7


          adds modules references in examples

12b286c

e8bc298


          Merge branch 'develop' of github.com:AequilibraE/aequilibrae into ren…

a73eb90

…ata/docs

Contributor

pedrocamargo commented Sep 5, 2024

@r-akemii , we will deprecate AequilibraE datasets, so you don;t need to bother to document it.

r-akemii added 5 commits

September 5, 2024 11:40


          adds new sections in docs

7ab7bfc


          docs

118e6bc

795ec5f


          Update 7-project_components.rst

a69e26a

674584b


          change project structure

10b11b7

pedrocamargo reviewed

View reviewed changes

docs/source/examples/assignment_workflows/plot_subarea_analysis.py Outdated Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/index.rst Outdated Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/examples/visualization/plot_display.py Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/project_database/transit_graph.rst Outdated Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/project_database/network.rst Outdated Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/project_database/network.rst Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/project_database/modes.rst Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/project_database/matrices.rst Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/project_database/link_types.rst Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/project_database/periods.rst Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/project_database/zones.rst Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/project_pieces/accessing_project_data.rst Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/route_choice/index.rst Outdated Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/modeling_with_aequilibrae/route_choice/index.rst Outdated Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/table_documentation.py Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/useful_information/support.rst Outdated Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/examples/assignment_workflows/plot_route_choice_set.py Outdated Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/examples/assignment_workflows/plot_forecasting.py Outdated Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/examples/trip_distribution/just_matrices.omx Outdated Show resolved Hide resolved

pedrocamargo reviewed

View reviewed changes

docs/source/examples/trip_distribution/select_link_analysis.omx Outdated Show resolved Hide resolved

pedrocamargo requested changes

View reviewed changes

Contributor

pedrocamargo left a comment

I left a ton of comments to be addressed throughout the PR

r-akemii added 3 commits

September 17, 2024 16:26


          changes

0715ee5


          Update plot_subarea_analysis.py

8a8b08e


          Update project_components.rst

34076a4

pedrocamargo approved these changes

View reviewed changes

r-akemii added 2 commits

September 18, 2024 11:31


          typos, tests, and admonitions

669e37b


          admonitions

70b4d79

r-akemii merged commit de9b26c into develop

16 checks passed

r-akemii deleted the renata/docs branch

September 18, 2024 16:26

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet