Add output files to the RTD output documentation - Githubissues

rl-institut / multi-vector-simulator

Multi-vector Simulation Tool assessing and optimizing Local Energy Systems (LES) for the E-LAND project

GNU General Public License v2.0

21 stars 10 forks source link

Add output files to the RTD output documentation #874

Closed smartie2076 closed 3 years ago

smartie2076 commented 3 years ago

Adresses #873

Changes proposed in this pull request:

Update eland-requirements.rst (reference)
Update MVS_kpi_categories.csv: Add category "files"
Update MVS_kpis_list.csv: All output files
Add the output file sections in the RTD simulation_outputs.rst
Adapt conf.py to include the output files in RTD properly

The following steps were realized, as well (if applies):

[x] Use in-line comments to explain your code
[x] Write docstrings to your code (example docstring)
:x: For new functionalities: Explain in readthedocs
:x: Write test(s) for your new patch of code (pytests, assertion debug messages)
[x] Update the CHANGELOG.md
[x] Apply black (black . --exclude docs/)
:x: Check if benchmark tests pass locally (EXECUTE_TESTS_ON=master pytest) -> only RTD changes

Please mark above checkboxes as following:

[ ] Open
[x] Done

:x: Check not applicable to this PR

_{For more information on how to contribute check the CONTRIBUTING.md.}

smartie2076 commented 3 years ago

Everthing looks fine! Except it seems like one description is missing for the 'example_input_timeseries.png', and maybe all the figures should have labels? But that's up to you. Also are the equations dispaying properly for you when you generate the html file?

Nice! I could not find out how figures can have captions in RTD. Do you know that this works in theory?