search

1kastner / conflowgen

A generator for synthetic container flows at maritime container terminals with a focus on yard operations
MIT License
11 stars 7 forks source link

Updating usage of mybinder in docs. #205

Open HarshithaPrabhuswamy opened 9 months ago

HarshithaPrabhuswamy commented 9 months ago

Update to make the Jupyter Notebooks in the docs interactive.

codecov[bot] commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (f9fde69) 94.11% compared to head (1cadc40) 94.17%. Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #205 +/- ## ========================================== + Coverage 94.11% 94.17% +0.06% ========================================== Files 122 122 Lines 4840 4843 +3 ========================================== + Hits 4555 4561 +6 + Misses 285 282 -3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

1kastner commented 9 months ago

Thank you @HarshithaPrabhuswamy for this nice addition that tackles #91.

Please drop the changes in Readme.md as we do not need to explain nbsphinx here.

Have you tried compiling the docs locally and did everything work out there? Please see https://github.com/1kastner/conflowgen/blob/main/Contributing.md#generate-the-documentation for hints on how to do that in case you haven't done so yet.

Please make sure that the links in the compiled documentation actually point at the documentation of ConFlowGen so that our Jupyter notebooks will turn interactive. Thanks for your effort!