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.

Sign up for GitHub

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

Add docs on installing nb-tester #2499

Merged
merged 2 commits into from
Dec 17, 2024
Merged

Add docs on installing nb-tester #2499

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a7464c
Add docs on installing nb-tester
frankharkins Dec 17, 2024
0384c50
Merge branch 'main' of github.com:Qiskit/documentation into FH/nb-tes…
Eric-Arellano Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions scripts/nb-tester/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,26 @@
A tool to execute notebooks for testing, with certain features useful for
notebooks that run jobs on IBM Quantum backends.

## Installing

To install, run the following command:

```
pip install git+https://github.com/Qiskit/documentation.git@main#subdirectory=scripts/nb-tester
```

> [!NOTE]
> If adding this package as a dependency, change `main` to point to a specific
> commit. For example:
> ```
> git+https://github.com/Qiskit/documentation.git@91bce99173f46be985698cc78ec4521856bf83b6#subdirectory=scripts/nb-tester
> ```
> This means changes to this repository won't break your tests. You can update
> the commit when you're ready to pull in our changes.

If adding this as a dependency to a `tox.ini` file, escape the `#` with a
backslash like this: `\#`.

## Basic usage

To use this tool, just run the `test-docs-notebooks` command, followed by a
Expand Down
Loading