Skip to content
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

Platform creation in the docs #984

Open
alecandido opened this issue Aug 15, 2024 · 0 comments
Open

Platform creation in the docs #984

alecandido opened this issue Aug 15, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@alecandido
Copy link
Member

There are multiple examples of platform creation in the docs, especially in lab.rst (and at least another one in experiment.rst).

Since the platform is created within a function, supposed to be invoked by Qibolab, it's often not tested. Same goes for the JSON snippets presented.

Instead, we should rather split these snippets as separate files, similarly to what is being done in #807, and test them outside Sphinx, which is easier and more practical.
We could just make a script to test them, and include it in poe test to be run after Pytest. This will make sure it's run even in the CI.

alecandido added a commit that referenced this issue Aug 15, 2024
alecandido added a commit that referenced this issue Aug 15, 2024
alecandido added a commit that referenced this issue Aug 16, 2024
alecandido added a commit that referenced this issue Aug 16, 2024
@alecandido alecandido mentioned this issue Aug 23, 2024
1 task
@stavros11 stavros11 mentioned this issue Sep 3, 2024
5 tasks
@alecandido alecandido added the documentation Improvements or additions to documentation label Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant