(v3.6.12) - Major documentation update #461
Merged
Conversation
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
|
@AlejandroCN7 Could you lend me a hand with |
AlejandroCN7
approved these changes
Nov 27, 2024
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.
Description
A complete revision of the Sinergym documentation, as well as of different parts of the repository, has been carried out in order to improve the format and presentation of the tool.
Types of changes
Checklist:
autopep8second level aggressive.isort.cd docs && make spelling && make htmlpass (required if documentation has been updated.)pytest tests/ -vvpass. (required).pytype -d import-error sinergym/pass. (required)Changelog:
Changelog
make spelling.Pending work
Add the most-up to date.bibreference.Replace current doc images by the updated images of the paper.Improve the images of the Wrappers docs section.Confirm whether the filetests/test_demo.pyis necessary.