Automatic documentation #141
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
|
The docs job in CI fails, because of a misformatted docstring in |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #141 +/- ##
==========================================
+ Coverage 40.76% 42.48% +1.71%
==========================================
Files 65 65
Lines 4452 4566 +114
==========================================
+ Hits 1815 1940 +125
+ Misses 2637 2626 -11 ☔ View full report in Codecov by Sentry. |
jlenain
added a commit
to jlenain/ctapipe_io_nectarcam
that referenced
this pull request
Jul 31, 2024
vmarandon
approved these changes
Jul 31, 2024
… checkout action (cta-observatory#140) Co-authored-by: Jean-Philippe Lenain <[email protected]>
…vision-with-micromamba (cta-observatory#139) Co-authored-by: Jean-Philippe Lenain <[email protected]>
* Add a Tool that can split data based on delimiter trigger * Improve documentation * A bit of cleaning * Refactored split_run, some coding style --------- Co-authored-by: Jean-Philippe Lenain <[email protected]>
….com/cta-observatory/ctapipe_io_nectarcam/actions/runs/10183584596/job/28168887272?pr=54 when building ctapipe_io_nectarcam (cta-observatory#142) Co-authored-by: Jean-Philippe Lenain <[email protected]>
Merged
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.
This PR extends #130 by including a full automatic documentation of the whole API, just by using the
recursiveoption ofsphinx.ext.autosummary.It also fixes quite a few typos in Docstrings, to comply with the reStructuredText format.