scnc
/
qiskit-documentation
mirror of https://github.com/Qiskit/documentation.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qiskit-documentation/tox.ini

24 lines
507 B
INI
Raw Normal View History

Add code to test notebook code examples (#471) This PR adds a script to automatically execute notebooks in CI. To keep PRs small and focussed, this only adds the scripts to test notebooks, it doesn't actually fix those notebooks or add anything to CI. <details> <summary>Example: Success</summary> ![Screenshot 2023-12-04 at 14 22 15](https://github.com/Qiskit/documentation/assets/36071638/2c6f698d-f990-456c-b20d-241db4d0007c) </details> <details> <summary>Example: Failure</summary> ![Screenshot 2023-12-04 at 14 23 17](https://github.com/Qiskit/documentation/assets/36071638/4983fcae-6d32-4c26-bdb3-4d6035d0a2fa) </details> <details> <summary>Why <code>tox</code>?</summary> An important feature is to be able to run a single notebook in the virtual environment. With `tox`, we can use commands like this: ```sh tox -- path/to/notebook ``` Whereas with `nox`, this is the simplest I could get it: ```sh nox --session 'test(path="path/to/notebook")' ``` Note this also doesn't autocomplete the path. The main reason for choosing `nox` seems to be more flexible configuration, but we only need simple configuration in this repo so this isn't a problem. </details> *** Part of #166 --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2023-12-06 00:05:44 +08:00
[tox]
min_version = 4.0
Restore Serverless 0.15.2 and test notebooks when changing requirements (#1831) Closes https://github.com/Qiskit/documentation/issues/1826. ## Switches to Python 3.11 Qiskit Serverless requires Python 3.11+ now, even though Qiskit SDK still supports 3.9 and 3.10. While I'm talking to the Serverless team, it seems very unlikely they are going to change their mind on this due to their own constraints. Unfortunately, this means that we need to always use Python 3.11 with our repository so that we can install serverless for the files that use it. Our other alternative is to stop testing the files with Serverless, but that seems even worse. The risk with using 3.11 in CI rather than 3.9 is that we may use syntax not in Python 3.9 and 3.10. However, given the actual history of our docs, this seems unlikely: we don't use new Python syntax like type hints. If we do use Python 3.11-syntax, it's not the end of the world. ## Tests all notebooks on changes to requirements.txt This was an oversight that we would not test the notebooks when changing requirements.txt. So, we merged a change that worked locally but broke CI. Now, we test all notebooks when the nb-tester program and config changes. ## Also upgrades Runtime This is necessary to make Serverless happy. According to https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/release-notes#0270-2024-08-08, there are no breaking changes. CI also shows everything passes.
2024-08-15 05:57:57 +08:00
env_list = py311
Add code to test notebook code examples (#471) This PR adds a script to automatically execute notebooks in CI. To keep PRs small and focussed, this only adds the scripts to test notebooks, it doesn't actually fix those notebooks or add anything to CI. <details> <summary>Example: Success</summary> ![Screenshot 2023-12-04 at 14 22 15](https://github.com/Qiskit/documentation/assets/36071638/2c6f698d-f990-456c-b20d-241db4d0007c) </details> <details> <summary>Example: Failure</summary> ![Screenshot 2023-12-04 at 14 23 17](https://github.com/Qiskit/documentation/assets/36071638/4983fcae-6d32-4c26-bdb3-4d6035d0a2fa) </details> <details> <summary>Why <code>tox</code>?</summary> An important feature is to be able to run a single notebook in the virtual environment. With `tox`, we can use commands like this: ```sh tox -- path/to/notebook ``` Whereas with `nox`, this is the simplest I could get it: ```sh nox --session 'test(path="path/to/notebook")' ``` Note this also doesn't autocomplete the path. The main reason for choosing `nox` seems to be more flexible configuration, but we only need simple configuration in this repo so this isn't a problem. </details> *** Part of #166 --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2023-12-06 00:05:44 +08:00
skipsdist = true
[testenv]
Make notebook tester into package (#1208) Makes the notebook tester into an installable package so we can re-use it in other repos. Main changes are: * Adding `pyproject.toml` and moving script to `qiskit_docs_notebook_tester/__init__.py` * Moving the lists of notebooks to a config file * Splitting the requirements needed for running the code in the notebooks form those neeed by the testing script itself The interface via `tox` should be unaffected. --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2024-04-24 23:14:49 +08:00
deps =
-e scripts/nb-tester
-r scripts/nb-tester/requirements.txt
Add code to test notebook code examples (#471) This PR adds a script to automatically execute notebooks in CI. To keep PRs small and focussed, this only adds the scripts to test notebooks, it doesn't actually fix those notebooks or add anything to CI. <details> <summary>Example: Success</summary> ![Screenshot 2023-12-04 at 14 22 15](https://github.com/Qiskit/documentation/assets/36071638/2c6f698d-f990-456c-b20d-241db4d0007c) </details> <details> <summary>Example: Failure</summary> ![Screenshot 2023-12-04 at 14 23 17](https://github.com/Qiskit/documentation/assets/36071638/4983fcae-6d32-4c26-bdb3-4d6035d0a2fa) </details> <details> <summary>Why <code>tox</code>?</summary> An important feature is to be able to run a single notebook in the virtual environment. With `tox`, we can use commands like this: ```sh tox -- path/to/notebook ``` Whereas with `nox`, this is the simplest I could get it: ```sh nox --session 'test(path="path/to/notebook")' ``` Note this also doesn't autocomplete the path. The main reason for choosing `nox` seems to be more flexible configuration, but we only need simple configuration in this repo so this isn't a problem. </details> *** Part of #166 --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2023-12-06 00:05:44 +08:00
setenv = PYDEVD_DISABLE_FILE_VALIDATION=1
Move config files to scripts/config (#1748) This is meant to better split config files vs source code, to make it more obvious what should be changed by everyday script users. Not all of the scripts use `config/` yet, but could be refactored in the future if we want.
2024-07-24 00:58:30 +08:00
commands = test-docs-notebooks {posargs} --config-path scripts/config/notebook-testing.toml
Add notebook linting (#724) Uses squeaky to lint notebooks. While this has some minor benefits (removing empty cells etc.), it will become much more useful when we switch notebook outputs to SVG.
2024-02-16 22:50:08 +08:00
Make notebook tester into package (#1208) Makes the notebook tester into an installable package so we can re-use it in other repos. Main changes are: * Adding `pyproject.toml` and moving script to `qiskit_docs_notebook_tester/__init__.py` * Moving the lists of notebooks to a config file * Splitting the requirements needed for running the code in the notebooks form those neeed by the testing script itself The interface via `tox` should be unaffected. --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2024-04-24 23:14:49 +08:00
[testenv:{lint,fix}]
deps = squeaky==0.7.0
commands =
Remove tutorials (#1660) This PR removes tutorial notebooks and related tools as they're being moved to a closed-source repository. --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
2024-07-16 04:17:34 +08:00
lint: squeaky --check --no-advice {posargs:docs}
fix: squeaky {posargs:docs}
Pull notebook classification out into separate test (#1397) We want to run the notebook classification check on every PR. This PR pulls that test out into a separate pytest suite and runs it as part of the standard CI job. I'd like to also add some more tests to this suite as the `nb-tester` has grown in complexity and there were some issues with it recently.
2024-05-18 04:24:08 +08:00
[testenv:nb-tester]
deps =
-e scripts/nb-tester
pytest
commands = pytest scripts/nb-tester