calliope-project / calliope

A multi-scale energy systems modelling framework
https://www.callio.pe
Apache License 2.0
277 stars 89 forks source link

Add mkdocs tabs option to math docs #564

Closed brynpickering closed 4 months ago

brynpickering commented 4 months ago

Improves math docs to include the math YAML snippet as a tab next to the LaTeX math string.

Summary of changes in this pull request:

Example:

https://github.com/calliope-project/calliope/assets/17178478/a8095c1b-9608-4953-8c9d-ab7d358f8510

Reviewer checklist:

codecov[bot] commented 4 months ago

Codecov Report

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

Comparison is base (6cce6ef) 95.83% compared to head (4d4c382) 95.83%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #564 +/- ## ======================================= Coverage 95.83% 95.83% ======================================= Files 24 24 Lines 3599 3604 +5 Branches 785 721 -64 ======================================= + Hits 3449 3454 +5 Misses 86 86 Partials 64 64 ``` | [Files](https://app.codecov.io/gh/calliope-project/calliope/pull/564?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project) | Coverage Δ | | |---|---|---| | [src/calliope/attrdict.py](https://app.codecov.io/gh/calliope-project/calliope/pull/564?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2F0dHJkaWN0LnB5) | `96.51% <100.00%> (+0.01%)` | :arrow_up: | | [src/calliope/backend/backend\_model.py](https://app.codecov.io/gh/calliope-project/calliope/pull/564?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvYmFja2VuZF9tb2RlbC5weQ==) | `97.90% <100.00%> (+0.01%)` | :arrow_up: | | [src/calliope/backend/latex\_backend\_model.py](https://app.codecov.io/gh/calliope-project/calliope/pull/564?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=calliope-project#diff-c3JjL2NhbGxpb3BlL2JhY2tlbmQvbGF0ZXhfYmFja2VuZF9tb2RlbC5weQ==) | `97.79% <100.00%> (+0.03%)` | :arrow_up: |