Closes#2112
A few questions for @Eric-Arellano about this:
- The notebook requires a separate text file to ingest orbital
information. I've put the contents in the page, but need to put the file
somewhere in the repo, I chose the `/guides/` directory to avoid
exposing the site's folder structure (and for easier reading by the
user). Is that alright to do?
- The notebook also requires `pyscf` to run. Should this dependency be
added to the `pyproject.toml` or `requirements.txt` in nb-tester?
Pedagogy question/notes for @javabster:
- I've cut out most of the circuit preparation and execution since the
SQD configuration recovery loop for this example can be run on synthetic
data. I think this helps focus in on the tooling of the package, but
wanted to make sure this was kosher since this example doesn't execute
anything on a QPU.
- I also think the full tutorial should be moved to the Learning
platform at some point (and this page should link out to it). It
contains good content and helpful information for users wanting to
prepare own chemistry workloads to post-process with SQD.
---------
Co-authored-by: abbycross <across@us.ibm.com>
Co-authored-by: Abby Mitchell <23662430+javabster@users.noreply.github.com>
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Caleb Johnson <calebj1524@outlook.com>
Note that /qiskit.circuit.library.IQP was deleted and is now
/qiskit.circuit.library.iqp because the class was deprecated in favor of
a function. However, the class page should not be deleted until Qiskit
2.0 so I will open a PR to fix this. Because it's dev docs, it's fine to
not block on this.
Cutting had a big change to show missing methods and un-inline some
classes. The other addons had smaller changes to show type hints even if
the parameter doesn't have docstring.
All changes were generated with `npm run gen-api`.
An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
> [!NOTE]
> This pull request was created by a GitHub action.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
> [!NOTE]
> This pull request was created by a GitHub action.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
> [!NOTE]
> This pull request was created by a GitHub action.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
> [!NOTE]
> This pull request was created by a GitHub action.
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
An action recently synced the latest dev docs. This PR updates all dev
APIs that changed.
> [!NOTE]
> This pull request was created by a GitHub action.
---------
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
All five addons now use the structure we expect of having a flat list of
module pages, along with an index page.
Thanks to this PR, we can now run `checkOrphanPages.ts` on the addon
projects.
Closes https://github.com/Qiskit/documentation/issues/2174. We now
convert URLs like `qiskit_addon_obp.MyClass` to `my-class`.
This is safe to change because the Addons are not yet public. We may
eventually want to do this for Qiskit, Runtime, and Transpiler Service -
for now, they stay the same.
We're in the process of adding six Qiskit addon API docs. This PR sets
up the initial projects so that it's easier for us to iterate on them,
such as running `npm run gen-api -- -a <path-to-html>` to see locally
how changes to Sphinx config impact the MDX pipeline.
The docs are _not_ ready to go live and they will not yet be synced by
closed source or deployed.
The quality issues will fixed in the project repositories, such as
https://github.com/Qiskit/qiskit-addon-obp/pull/24.
## API naming scheme
We call the API by their full name, without their abbrevation. For
example, "Operator Backpropagation" rather than "OBP" or "Operator
Backpropagation (OBP)".
We do not explicitly mention "Qiskit addon" in the API name. It's
already evident these are addons by looking at the left ToC which shows
the full module path like `qiskit_addon_obp`.
## URL scheme
Each package's URL matches their PyPI name, like `qiskit-addon-obp`.
Note that we may want to normalize the URLs for individual pages to
follow SEO best practices, e.g.
`/api/qiskit-addon-obp/qiskit_addon_obp.utils.simplify` would be
`/api/qiskit-addon-obp/qiskit-addon-obp-utils-simplify`. We would make
this change in a follow up PR.
Note that several APIs were removed from Runtime. I'll set up redirects
in closed source.
This PR also updates the dev docs for Qiskit. For some reason, our cron
job isn't actually opening up PRs.
Generated with `npx tsx scripts/js/commands/api/syncDevDocs.ts` (cron
job currently not working).
Note that Runtime removes all v1 Fake Provider pages. We'll set up
redirects once this version becomes stable.
There is also a Qiskit SDK regression tracked by
https://github.com/Qiskit/qiskit/issues/13258.
For some reason, the generated docs were missing some entries in
objects.inv. This was generated by running `npm run regen-apis -- -p
qiskit-ibm-transpiler`.
Looks like this image got corrupted in #2006 and we didn't notice. This
PR restores the image to it's state before that commit using the
following command.
```sh
git restore public/images/guides/ibm-circuit-function/ibm-circuit-function.svg --source 47688a1c86
```
Related to #2037
This is our first time generating the dev docs in an automated way
through the new script added in
https://github.com/Qiskit/documentation/pull/2017.
Note that we now store GitHub URLs for the artifacts, rather than Box.
These will become stale in 90 days, so this would not be safe to do for
stable docs. But it's okay for dev docs since we update them more
frequently than every 90 days.
Gens:
* Runtime dev
* Runtime 0.29.1
* Transpiler 0.7.0
Manually bumps the versions for Transpiler 0.5 and 0.6 (no docs changes
were made). Also updates the link checker for Runtime due to a shift in
its index.html page.
Also makes the Runtime link ignores more precise. I spent twenty minutes
trying to figure out why `objects.inv` still has a broken link
`index#qiskit-runtime-version-api-docs-preview` in Runtime but not
Transpiler Service & Qiskit. I couldn't figure it out, so moved on.
1st draft for documentation about the Qiskit Code Assistant. Should fix
#1930
Considerations:
- Rough draft, feel free to edit or give any feedback
- I'm not sure if we should split the documentation in 2 parts: one for
JupyterLab extension and another one for the VSCode extension
- I'm not sure the where the Qiskit Code Assistant should be placed in
the TOC
- I added content that depends on #1918
---------
Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
Co-authored-by: Rebecca Dimock <beckyd@us.ibm.com>
Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
This brings in a fix for
https://github.com/Qiskit/documentation/issues/798, which means that we
need to set up our historical redirects for those RST files in Qiskit to
go to the now renamed files. I will set up redirects in closed source.
We have some attribute pages that are aliases, like `Sampler` being an
alias for `SamplerV1`. These pages weren't showing up in the ToC
(orphans) because of an oversight.
This PR also makes these improvements:
* Fixes our code for copying release note images to the correct location
for Qiskit, as a continuation of
https://github.com/Qiskit/documentation/pull/1914
* Uses `ApiType` rather than `string` in more places so that we get
stronger typing
* Removes an unused arg, `$main`
https://github.com/Qiskit/documentation/pull/1848 only fixed `npm run
make-historical`, but not `npm run gen-api` and `npm run regen-apis`.
With this PR, 1.1 stays the same when regenerating, whereas before the
release note changed.
I also manually changed the Sphinx artifact for 1.0 to fix a link to a
page we migrated.
There were some changes that we didn't properly set up by regenerating
the API docs. This runs `npm run regen-apis`.
The file docs/api/qiskit-ibm-runtime/0.23/options.mdx was manually
changed in the uploaded Box artifact to avoid a regression where the
link changed to point to current API docs for a page that was deleted.
All the pages were renamed in 0.5, so we'll set up redirects in closed
source.
We also set up precise redirects in `historical-pages-to-latest.json`.
Otherwise, those pages would have gone to `/` (root).
Part of https://github.com/Qiskit/documentation/issues/1870. We'll set
up redirects in closed source from `qiskit-transpiler-service/*` to
`qiskit-ibm-transpiler/*`.
We don't yet generate `qiskit-ibm-transpiler` version 0.5 because that
is going to require a new set of more specific redirects, as the page
names will change from `qiskit_transpiler_service.Foo` to
`qiskit_ibm_transpiler.Foo`. That'll be done in a follow up after this
initial migration is complete.
This means that we now have our first historical version of
qiskit-transpiler-service: 0.3. So, we need to update
`checkInternalLinks.ts` to start checking historical versions.
We don't yet add a dev version because it's annoying to maintain and the
users are too few for now.
Kaelyn Ferris