Add output files to the RTD output documentation#874
Merged
smartie2076 merged 8 commits intodevfrom May 3, 2021
Merged
Conversation
13 tasks
aefcb12 to
ae5888b
Compare
This was referenced Apr 28, 2021
ciaradunks
approved these changes
May 3, 2021
Contributor
ciaradunks
left a comment
There was a problem hiding this comment.
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?
ciaradunks
reviewed
May 3, 2021
b20978f to
d94f610
Compare
Collaborator
Author
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
d99c403 to
288c52f
Compare
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adresses #873
Changes proposed in this pull request:
eland-requirements.rst(reference)MVS_kpi_categories.csv: Add category "files"MVS_kpis_list.csv: All output filessimulation_outputs.rstconf.pyto include the output files in RTD properlyThe following steps were realized, as well (if applies):
black . --exclude docs/)EXECUTE_TESTS_ON=master pytest) -> only RTD changesPlease mark above checkboxes as following:
❌ Check not applicable to this PR
For more information on how to contribute check the CONTRIBUTING.md.