You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
But it's completely written manually, and independent of the state of qibocal.protocols.
It may be nice to autogenerate some pages, including the index, based on the package content.
Essentially, we may add to the Routine object some labels (metadata), that help to categorize them, and link to the manually written pages.
E.g. the index at https://github.com/qiboteam/qibocal/blob/main/doc/source/protocols/index.rst may be based on category names, collected through a scan of the content of qibocal.package.
The unlabeled routines may inherit an "Others" label, such that they all fall in a single category, whose page may be automatically generated as well, just listing the interface of all the routines in the category (possibly exposing even the module/class docstring somewhere).
In principle, we could autogenerate all the pages, just writing the content in the modules. However, I personally don't like too much mixing the users' documentation with the source content (though there are plenty of popular packages doing it), so I'd rather keep the current protocols' guides where they are, and just autogenerate the interface for those who don't have a manually crafted page.
The text was updated successfully, but these errors were encountered:
A "Protocols" section in the docs already exists:
https://github.com/qiboteam/qibocal/blob/main/doc/source/protocols/index.rst
But it's completely written manually, and independent of the state of
qibocal.protocols
.It may be nice to autogenerate some pages, including the index, based on the package content.
Essentially, we may add to the
Routine
object some labels (metadata), that help to categorize them, and link to the manually written pages.E.g. the index at https://github.com/qiboteam/qibocal/blob/main/doc/source/protocols/index.rst may be based on category names, collected through a scan of the content of
qibocal.package
.The unlabeled routines may inherit an
"Others"
label, such that they all fall in a single category, whose page may be automatically generated as well, just listing the interface of all the routines in the category (possibly exposing even the module/class docstring somewhere).In principle, we could autogenerate all the pages, just writing the content in the modules. However, I personally don't like too much mixing the users' documentation with the source content (though there are plenty of popular packages doing it), so I'd rather keep the current protocols' guides where they are, and just autogenerate the interface for those who don't have a manually crafted page.
The text was updated successfully, but these errors were encountered: