Add auto-generated docs for custom math examples

calliope-project / calliope

A multi-scale energy systems modelling framework

https://www.callio.pe

Apache License 2.0

277 stars 90 forks source link

Add auto-generated docs for custom math examples #508

Closed sjpfenninger closed 6 months ago

sjpfenninger commented 8 months ago

Summary of changes in this pull request:

Changed comment strings into commented-out YAML with a "title" and "description" for each example (the # --- comment marks the end of the "docs comment")
Added code to auto-generate custom math documentation

Reviewer checklist:

[ ] Test(s) added to cover contribution
[ ] Documentation updated
[ ] Changelog updated
[ ] Coverage maintained or improved

sjpfenninger commented 6 months ago

Closing this because it is superseded by #526 (which addresses all of the issues pointed out in the review, with the possible exception of the question on | vs >)