qiboteam / qibocal

Quantum calibration, characterization and validation module for Qibo.
https://qibo.science
Apache License 2.0
28 stars 4 forks source link

Fix protocols documentation generation #854

Closed andrea-pasquale closed 1 month ago

andrea-pasquale commented 1 month ago

The protocols were not shown correctly in the documentation. This PR fixes the issue. We could start from here to improve the documentation.

Checklist:

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.28%. Comparing base (6633379) to head (48c5429).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/qiboteam/qibocal/pull/854/graphs/tree.svg?width=650&height=150&src=pr&token=3EA9ZUNKUY&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam)](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam) ```diff @@ Coverage Diff @@ ## main #854 +/- ## ========================================== - Coverage 97.30% 97.28% -0.03% ========================================== Files 107 107 Lines 7915 7915 ========================================== - Hits 7702 7700 -2 - Misses 213 215 +2 ``` | [Flag](https://app.codecov.io/gh/qiboteam/qibocal/pull/854/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/qiboteam/qibocal/pull/854/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam) | `97.28% <100.00%> (-0.03%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam) | Coverage Δ | | |---|---|---| | [src/qibocal/auto/task.py](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&filepath=src%2Fqibocal%2Fauto%2Ftask.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#diff-c3JjL3FpYm9jYWwvYXV0by90YXNrLnB5) | `99.13% <100.00%> (ø)` | | | [src/qibocal/fitting/classifier/qubit\_fit.py](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&filepath=src%2Fqibocal%2Ffitting%2Fclassifier%2Fqubit_fit.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#diff-c3JjL3FpYm9jYWwvZml0dGluZy9jbGFzc2lmaWVyL3F1Yml0X2ZpdC5weQ==) | `100.00% <100.00%> (ø)` | | | [src/qibocal/protocols/\_\_init\_\_.py](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&filepath=src%2Fqibocal%2Fprotocols%2F__init__.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#diff-c3JjL3FpYm9jYWwvcHJvdG9jb2xzL19faW5pdF9fLnB5) | `100.00% <ø> (ø)` | | | [src/qibocal/protocols/allxy/allxy.py](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&filepath=src%2Fqibocal%2Fprotocols%2Fallxy%2Fallxy.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#diff-c3JjL3FpYm9jYWwvcHJvdG9jb2xzL2FsbHh5L2FsbHh5LnB5) | `100.00% <ø> (ø)` | | | [...qibocal/protocols/allxy/allxy\_drag\_pulse\_tuning.py](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&filepath=src%2Fqibocal%2Fprotocols%2Fallxy%2Fallxy_drag_pulse_tuning.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#diff-c3JjL3FpYm9jYWwvcHJvdG9jb2xzL2FsbHh5L2FsbHh5X2RyYWdfcHVsc2VfdHVuaW5nLnB5) | `100.00% <ø> (ø)` | | | [src/qibocal/protocols/classification.py](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&filepath=src%2Fqibocal%2Fprotocols%2Fclassification.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#diff-c3JjL3FpYm9jYWwvcHJvdG9jb2xzL2NsYXNzaWZpY2F0aW9uLnB5) | `100.00% <100.00%> (ø)` | | | [src/qibocal/protocols/coherence/spin\_echo.py](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&filepath=src%2Fqibocal%2Fprotocols%2Fcoherence%2Fspin_echo.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#diff-c3JjL3FpYm9jYWwvcHJvdG9jb2xzL2NvaGVyZW5jZS9zcGluX2VjaG8ucHk=) | `95.12% <ø> (ø)` | | | [...rc/qibocal/protocols/coherence/spin\_echo\_signal.py](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&filepath=src%2Fqibocal%2Fprotocols%2Fcoherence%2Fspin_echo_signal.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#diff-c3JjL3FpYm9jYWwvcHJvdG9jb2xzL2NvaGVyZW5jZS9zcGluX2VjaG9fc2lnbmFsLnB5) | `100.00% <ø> (ø)` | | | [src/qibocal/protocols/coherence/t1.py](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&filepath=src%2Fqibocal%2Fprotocols%2Fcoherence%2Ft1.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#diff-c3JjL3FpYm9jYWwvcHJvdG9jb2xzL2NvaGVyZW5jZS90MS5weQ==) | `93.93% <ø> (ø)` | | | [src/qibocal/protocols/coherence/t1\_sequences.py](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree&filepath=src%2Fqibocal%2Fprotocols%2Fcoherence%2Ft1_sequences.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam#diff-c3JjL3FpYm9jYWwvcHJvdG9jb2xzL2NvaGVyZW5jZS90MV9zZXF1ZW5jZXMucHk=) | `100.00% <ø> (ø)` | | | ... and [71 more](https://app.codecov.io/gh/qiboteam/qibocal/pull/854?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=qiboteam) | |