-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add proper protocols documentation #861
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #861 +/- ##
==========================================
- Coverage 97.40% 97.32% -0.09%
==========================================
Files 115 115
Lines 8645 8645
==========================================
- Hits 8421 8414 -7
- Misses 224 231 +7
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Co-authored-by: Rodolfo Carobene <[email protected]>
Thanks @andrea-pasquale and @Edoardo-Pedicillo! |
Yes, we know. We are planning to move to a single page with all references. I'm not sure if this will fix the issue. We need to have a look into sphinx. |
Co-authored-by: Andrea Pasquale <[email protected]>
Documentation for tof and kernels
Co-authored-by: Andrea Pasquale <[email protected]>
@rodolfocarobene @Edoardo-Pedicillo if you have further comments let me know. I would like to merge this PR today. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM !
Co-authored-by: Edoardo Pedicillo <[email protected]>
I'll merge now. Thanks everyone for contributing and reviewing. |
This PR aims at providing a comprehensible documentation for all protocols available in qibocal.
TODOs:
autoclass
to show Parameters in the same pageProtocols: