Update documentation preparation #209
Merged
Conversation
This file contains 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
Use SINTEF/ci-cd pre-commit hooks. Remove the invoke tasks. Update options for the documentation file that showcases all the strategies.
Ensure everything is shown, even if it has no explicit doc-string.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #209 +/- ##
=======================================
Coverage 88.67% 88.67%
=======================================
Files 15 15
Lines 459 459
=======================================
Hits 407 407
Misses 52 52
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
francescalb
approved these changes
Feb 23, 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:
Closes #83
Closes #196
Update the way the API reference is updated in the documentation.
Update the
all_strategies.mdfile to actually include all strategies.Remove the now unused invoke tasks related to update the API reference and landing page in the documentation.
Add a line in the README referencing the documentation page including all strategies.
Update the link used for the above reference to be relative when generating the documentation landing page.
Type of change:
Checklist for the reviewer:
This checklist should be used as a help for the reviewer.