Standardize documentation for new layout

[andrea-pasquale]

This PR uses the same layout for the documentation already used in other qibo repositories.
Now the API reference is also generated automatically.

Checklist:

• Reviewers confirm new code works as expected.
• Tests are passing.
• Coverage does not decrease.
• Documentation is updated.
• Compatibility with Qibo modules (Please edit this section if the current pull request is not compatible with the following branches).
  • Qibo: master
  • Qibolab: main
  • Qibolab_platforms_qrc: main

[codecov]

Codecov Report

Merging #511 (aff5c62) into main (00d27e0) will decrease coverage by 0.20%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #511      +/-   ##
==========================================
- Coverage   96.28%   96.09%   -0.20%     
==========================================
  Files          63       61       -2     
  Lines        4636     4503     -133     
==========================================
- Hits         4464     4327     -137     
- Misses        172      176       +4     

Flag	Coverage Δ
unittests	96.09% <100.00%> (-0.20%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage
src/qibocal/auto/operation.py	ø
src/qibocal/protocols/characterization/__init__.py	ø
src/qibocal/protocols/characterization/ramsey.py	ø
src/qibocal/auto/task.py	100.00%
src/qibocal/fitting/classifier/run.py	100.00%

📢 Thoughts on this report? Let us know!.

[andrea-pasquale]

@scarrazza we may also consider removing some outdated documentation related to the RB.
https://github.com/qiboteam/qibocal/tree/new_layout_doc/doc/source/getting-started/niGSC
Mostly because this features are not supported (being able to run protocols without passing through the qibocal API).
I would rather removing it simply because we clean up all the documentation and this is the only old part still present.
Let me know what you think.

[scarrazza]

Ok, fine by me.

[Edoardo-Pedicillo]

Thank @andrea-pasquale. LGTM

[andrea-pasquale]

Ok, fine by me.

I removed it now.

[scarrazza]

Looks good, could you please add some image in the front-page summarizing the features in qibocal (one of the xmind we already have)?

[andrea-pasquale]

I've just added the image.

[scarrazza]

Looks good, thanks

[scarrazza]

@andrea-pasquale could you please update poetry and make sure the proper release versions of qibolab/qibo, etc. are correct?

[andrea-pasquale]

Qibo it is fine, I believe.
For qibolab, do you want the stable release?

[andrea-pasquale]

For qibolab, do you want the stable release?

This could create issues when treating errors later on, given that we will need to merge a PR in qibolab.

[scarrazza]

Well, but one of the major points of making a release of qibocal now, is the compatibility with the stable release in qibolab, no? Later we will make another qibolab release and then update this repository.

[andrea-pasquale]

Well, but one of the major points of making a release of qibocal now, is the compatibility with the stable release in qibolab, no? Later we will make another qibolab release and then update this repository.

Sure I will change it to the stable release

[andrea-pasquale]

Tests are not passing because in qibolab we recently merged qiboteam/qibolab#574

[andrea-pasquale]

It is my mistake since I merged #501 which was related to the 0.0.4 release.

[scarrazza]

Is it possible to patch qibocal temporarily for the 0.0.3 release, avoiding the usage of this new feature in qibolab?

[andrea-pasquale]

Is it possible to patch qibocal temporarily for the 0.0.3 release, avoiding the usage of this new feature in qibolab?

I can remove the new protocols from tests and decrease coverage. Otherwise I will need to revert the PR.

[scarrazza]

You can do the following, open another PR with the revert changes, we then merge, make a release and finally you revert.

[scarrazza]

Could you please also merge main here?

[andrea-pasquale]

Actually I cannot merge it since #512 already started from main. Can I put a merge commit anyway (I'm looking on how to do it).

[scarrazza]

Ok, then let's hope that the CI passes.

[andrea-pasquale]

@scarrazza after the CI finishes we should be ready to merge . There is only a small decrease in coverage which should be fine I think.

[scarrazza]

Sure, lets wait for it.