search

VROOM-Project / pyvroom

Vehicle Routing Open-source Optimization Machine
BSD 2-Clause "Simplified" License
67 stars 14 forks source link

Adding documentation #114

Open jonathf opened 2 months ago

jonathf commented 2 months ago

Using Jupyter-book and autosummary to automatically generate a proper reference manual.

codecov[bot] commented 2 months ago

Codecov Report

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

Project coverage is 79.1%. Comparing base (7fc9070) to head (a2bea20).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #114 +/- ## ===================================== Coverage 79.1% 79.1% ===================================== Files 29 29 Lines 1628 1629 +1 Branches 138 138 ===================================== + Hits 1288 1289 +1 Misses 330 330 Partials 10 10 ``` | [Flag](https://app.codecov.io/gh/VROOM-Project/pyvroom/pull/114/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VROOM-Project) | Coverage Δ | | |---|---|---| | [binding](https://app.codecov.io/gh/VROOM-Project/pyvroom/pull/114/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VROOM-Project) | `69.1% <ø> (ø)` | | | [python](https://app.codecov.io/gh/VROOM-Project/pyvroom/pull/114/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VROOM-Project) | `91.4% <100.0%> (+<0.1%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=VROOM-Project#carryforward-flags-in-the-pull-request-comment) to find out more.