search

arup-group / pam

Generate and modify transport demand scenarios via a Python API.
MIT License
55 stars 21 forks source link

Streamline docs #245

Closed brynpickering closed 1 year ago

brynpickering commented 1 year ago

I've streamlined some parts of the docs so there's less to maintain.

  1. moved the Python API reference generator into the hook script, so we don't need to maintain a custom MKDocs plugin.
  2. moved tiny readme into a HTML header comment in the one file the README was referring to.
  3. Added auto-generation of example notebooks in the MKDocs navigation tree, so no need to remember to put them there / update refs when renaming notebooks (as was initially forgotten in #239).

Checklist

Any checks which are not relevant to the PR can be pre-checked by the PR creator. All others should be checked by the reviewer(s). You can add extra checklist items here if required by the PR.

codecov-commenter commented 1 year ago

Codecov Report

Merging #245 (5ca6fad) into main (07813c8) will increase coverage by 0.66%. Report is 63 commits behind head on main. The diff coverage is 87.86%.

@@            Coverage Diff             @@
##             main     #245      +/-   ##
==========================================
+ Coverage   86.84%   87.51%   +0.66%     
==========================================
  Files          49       47       -2     
  Lines        5496     5518      +22     
  Branches     1372     1392      +20     
==========================================
+ Hits         4773     4829      +56     
+ Misses        462      424      -38     
- Partials      261      265       +4
Files Changed Coverage Δ
pam/activity.py 90.90% <ø> (+0.14%) :arrow_up:
pam/read/__init__.py 100.00% <ø> (ø)
pam/write/__init__.py 100.00% <ø> (ø)
pam/write/matsim.py 76.08% <59.25%> (-2.58%) :arrow_down:
pam/optimise/grid.py 76.74% <70.00%> (+33.88%) :arrow_up:
pam/optimise/random.py 89.09% <71.42%> (+47.91%) :arrow_up:
pam/core.py 88.72% <87.87%> (+0.68%) :arrow_up:
pam/read/matsim.py 87.57% <93.33%> (-0.85%) :arrow_down:
pam/vehicles.py 94.97% <94.97%> (ø)
pam/__init__.py 100.00% <100.00%> (ø)
... and 3 more

... and 1 file with indirect coverage changes

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more