[ ] I have already submitted an issue or discussion thread to discuss my idea with the maintainers.
What kind of change does this PR introduce? (check at least one)
[ ] Bugfix
[ ] Feature
[x] Documentation
[ ] Tutorial
[ ] Code style update
[ ] Refactor
[ ] Build-related changes
[ ] Other, please describe:
Does this PR introduce a breaking change? (check one)
[ ] Yes
[x] No
If yes, please describe the impact and communicate accordingly:
The PR fulfills these requirements:
[ ] It's submitted to the branch named as follow :
Fix a bug: bugfix-<some_key>-<word>
Improve the doc: doc-<some_key>-<word>
Improve a tutorial tutorial-<some_key>-<word>
Add a new feature: feature-<some_key>-<word>
Refactor some code: refactor-<some_key>-<word>
Optimize some code: optimize-<some_key>-<word>
[ ] When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)
[ ] Don't forget to link PR to issue if you are solving one.
[x] All tests are passing.
[ ] New/updated tests are included
If adding a new feature, the PR's description includes:
[ ] A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)
coverage: 0.138%. remained the same when pulling 696596a0398f4af58b03fc60cfa9e031efd3e635 on EPFL-ENAC:feat-doc-template into 636e118c0ef5824d7410ec696e05d8db71fd0d82 on ghiggi:main.
Beautiful ! Thanks a lot !
We can adopt this also for the other repositories (and disdrodb :smile:)
Also add the automatic API generation as in this repo ;)
Prework
What kind of change does this PR introduce? (check at least one)
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and communicate accordingly:
The PR fulfills these requirements:
bugfix-<some_key>-<word>
doc-<some_key>-<word>
tutorial-<some_key>-<word>
feature-<some_key>-<word>
refactor-<some_key>-<word>
optimize-<some_key>-<word>
fix #xxx[,#xxx]
, where "xxx" is the issue number)If adding a new feature, the PR's description includes:
Other information:
Related GitHub issues and pull requests
Summary
See on Readthedocs