EnergySystemsModellingLab / MUSE_2.0

Welcome to the MUSE 2.0 repository
GNU General Public License v3.0
1 stars 0 forks source link

Build and publish manual with mdBook #47

Closed alexdewar closed 3 weeks ago

alexdewar commented 3 weeks ago

This PR adds some skeleton files for the documentation and adds a CI workflow to build them with mdBook and publish to GitHub Pages. I've tested it by manually running the workflow. You can see the results here: https://energysystemsmodellinglab.github.io/MUSE_2.0/

The API documentation is still being published to GitHub Pages too; it's accessible via a link on the main page.

Closes #36.

codecov[bot] commented 3 weeks ago

Codecov Report

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

Project coverage is 81.81%. Comparing base (e237e28) to head (0232e77).

:exclamation: Current head 0232e77 differs from pull request most recent head 76fcbad

Please upload reports for the commit 76fcbad to get more accurate results.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #47 +/- ## ======================================= Coverage 81.81% 81.81% ======================================= Files 7 7 Lines 77 77 ======================================= Hits 63 63 Misses 14 14 ```

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