Skip to content

Add output files to the RTD output documentation#874

Merged
smartie2076 merged 8 commits intodevfrom
fix/output_parameters_files
May 3, 2021
Merged

Add output files to the RTD output documentation#874
smartie2076 merged 8 commits intodevfrom
fix/output_parameters_files

Conversation

@smartie2076
Copy link
Copy Markdown
Collaborator

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):

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

Please mark above checkboxes as following:

  • Open
  • Done

❌ Check not applicable to this PR

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

@smartie2076 smartie2076 added the documentation Improvements or additions to documentation label Apr 28, 2021
@smartie2076 smartie2076 requested a review from ciaradunks April 28, 2021 10:35
@smartie2076 smartie2076 self-assigned this Apr 28, 2021
@smartie2076 smartie2076 force-pushed the fix/output_parameters_files branch from aefcb12 to ae5888b Compare April 28, 2021 13:56
Copy link
Copy Markdown
Contributor

@ciaradunks ciaradunks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@smartie2076 smartie2076 force-pushed the rtd/output_parameters branch from b20978f to d94f610 Compare May 3, 2021 15:13
Base automatically changed from rtd/output_parameters to dev May 3, 2021 15:18
@smartie2076
Copy link
Copy Markdown
Collaborator Author

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?

- 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`
Add more output files
@smartie2076 smartie2076 force-pushed the fix/output_parameters_files branch from d99c403 to 288c52f Compare May 3, 2021 15:28
@smartie2076 smartie2076 merged commit 6eb3d97 into dev May 3, 2021
@smartie2076 smartie2076 deleted the fix/output_parameters_files branch May 3, 2021 16:02
@smartie2076 smartie2076 mentioned this pull request May 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants