scnc
/
qiskit
mirror of https://github.com/Qiskit/qiskit.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
qiskit/docs/release_notes.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

24 lines
825 B
ReStructuredText
Raw Normal View History

Merge documentation and benchmarks from metapackage This cross-repository merge unifies the documentation, benchmarks and code of conduct from the metapackage into Qiskit/Terra's build. There are very non-trivial merge conflicts that have been resolved by this commit. The summary is: - `CODE_OF_CONDUCT.md`: taken directly from the metapackage's version. - `docs/conf.py`: strongly unified, albeit without the translations components that are added in a separate commit. - `docs/index.rst`: taken almost verbatim from the metapackage. All the API documentation RST files on Terra are moved to `docs/apidoc` (without the trailing 's') to match the metapackage expectation, so the URLs of built documentation will not change. - `docs/release_notes.rst`: The metapackage's version is renamed to `docs/legacy_release_notes.rst`, given a small introductory header, and made an orphan linked only from a _new_ `docs/release_notes.rst` that uses `reno`. - `docs/tutorials.rst`: Mostly these were the same already. Updated to include Qiskit/Terra's correction that it's not an orphan, and contain the metapackage's extra intro tutorial. - `docs/apidoc/terra.rst`: renamed to `docs/apidoc/index.rst` and retitled to be correctly just "API Documentation". - `requirements-dev.txt`: the version of the Sphinx theme is bumped to 1.14 to match the metapackage expectation.
2023-08-12 02:38:05 +08:00
.. _release-notes:
[WIP] Add release notes for Terra release 0.8 (Qiskit/qiskit-metapackage#211) * Start release notes for Terra release 0.8 This commit starts the release notes for the Terra 0.8 release. They're still a WIP, this is just the start and more details need to be flushed out before the release. * Fix lint and small tweaks
2019-04-29 22:03:50 +08:00
Revert "Revert to one release notes file (#10639)" (#10656) * Revert "Revert to one release notes file (#10639)" The change to the release notes organization is only needed for the stable/0.25 branch longer term. Moving forward we'll have a different release notes strategy likely using the reno sphinx extension directly. In the short term this reverts to the previous state prior to #10639 as while #10639 was necessary for getting 0.25.1 released it did turn off our CI coverage testing that release notes would be built. Restoring this is important so we know from CI whether a change to the release notes works as part of the docs build. This reverts commit 0388d543dee1fe59f07b257fa218fe99511397c8. * Sync release notes from 0.25.1 * Apply typo fix from #10711
2023-09-02 03:01:14 +08:00
=============
Merge documentation and benchmarks from metapackage This cross-repository merge unifies the documentation, benchmarks and code of conduct from the metapackage into Qiskit/Terra's build. There are very non-trivial merge conflicts that have been resolved by this commit. The summary is: - `CODE_OF_CONDUCT.md`: taken directly from the metapackage's version. - `docs/conf.py`: strongly unified, albeit without the translations components that are added in a separate commit. - `docs/index.rst`: taken almost verbatim from the metapackage. All the API documentation RST files on Terra are moved to `docs/apidoc` (without the trailing 's') to match the metapackage expectation, so the URLs of built documentation will not change. - `docs/release_notes.rst`: The metapackage's version is renamed to `docs/legacy_release_notes.rst`, given a small introductory header, and made an orphan linked only from a _new_ `docs/release_notes.rst` that uses `reno`. - `docs/tutorials.rst`: Mostly these were the same already. Updated to include Qiskit/Terra's correction that it's not an orphan, and contain the metapackage's extra intro tutorial. - `docs/apidoc/terra.rst`: renamed to `docs/apidoc/index.rst` and retitled to be correctly just "API Documentation". - `requirements-dev.txt`: the version of the Sphinx theme is bumped to 1.14 to match the metapackage expectation.
2023-08-12 02:38:05 +08:00
Release Notes
Revert "Revert to one release notes file (#10639)" (#10656) * Revert "Revert to one release notes file (#10639)" The change to the release notes organization is only needed for the stable/0.25 branch longer term. Moving forward we'll have a different release notes strategy likely using the reno sphinx extension directly. In the short term this reverts to the previous state prior to #10639 as while #10639 was necessary for getting 0.25.1 released it did turn off our CI coverage testing that release notes would be built. Restoring this is important so we know from CI whether a change to the release notes works as part of the docs build. This reverts commit 0388d543dee1fe59f07b257fa218fe99511397c8. * Sync release notes from 0.25.1 * Apply typo fix from #10711
2023-09-02 03:01:14 +08:00
=============
Adding terra documentation (Qiskit/qiskit-metapackage#35)
2019-01-13 20:52:32 +08:00
Remove Qiskit Terra 0.25 from release_notes.rst (#11436) * Remove Qiskit Terra 0.25 from release_notes.rst * Review feedback: use a comment
2023-12-22 04:29:12 +08:00
This page contains the release notes for Qiskit, starting from Qiskit 0.45, the first time that Qiskit and Qiskit Terra had the same versions.
..
These release notes get converted into Markdown files via the infrastructure at https://github.com/Qiskit/documentation, which then gets deployed to https://docs.quantum.ibm.com/api/qiskit/release-notes. Changes to these release notes will update those release notes the next time the API docs are generated.
To change release notes prior to Qiskit 0.45, update the Qiskit/documentation repository directly.
Adding terra documentation (Qiskit/qiskit-metapackage#35)
2019-01-13 20:52:32 +08:00
Revert "Revert to one release notes file (#10639)" (#10656) * Revert "Revert to one release notes file (#10639)" The change to the release notes organization is only needed for the stable/0.25 branch longer term. Moving forward we'll have a different release notes strategy likely using the reno sphinx extension directly. In the short term this reverts to the previous state prior to #10639 as while #10639 was necessary for getting 0.25.1 released it did turn off our CI coverage testing that release notes would be built. Restoring this is important so we know from CI whether a change to the release notes works as part of the docs build. This reverts commit 0388d543dee1fe59f07b257fa218fe99511397c8. * Sync release notes from 0.25.1 * Apply typo fix from #10711
2023-09-02 03:01:14 +08:00
.. release-notes::
Collapse release notes for pre-releases (backport #11224) (#11229) * Collapse release notes for pre-releases (#11224) * Collapse release notes for pre-releases This commit tweaks the reno sphinx directive usage to collapse the pre-releases. The big piece of this is splitting into using multiple directives for each minor stable release branch. Each directive explicitly sets the scanning branch to the stable branches. The underlying issue with a single directive was that the reno git scanner wasn't seeing the final release tags on main as the tags only exist on the stable branches. The extra benefit of this is that we also get the bugfix releases included now. * Adjust reno pre-release tag regex This commit adjusts the pre-release tag regex to match how qiskit tags pre-releases. The default pre release regex is: ``` (?P<pre_release>\.v?\d+(?:[ab]|rc)+\d*)$ ``` which for Qiskit's pre-release tag format, the `pre_release` match includes the patch version. For example, `0.45.0rc1` matches as `0rc1`. But the actual pre_release match should be `rc1`. This commit adjusts the regex to work for qiskit's tag format, and also include support for `pre` syntax (which is pep440 compatible) pre-releases. (cherry picked from commit f3fb08990fb2769384fa65099d943a2fda0a1875) # Conflicts: # releasenotes/config.yaml * Fix conflict, add new directives * Restore regex update * Update docs/release_notes.rst * Change earliest version to 0.45.0rc1 * Change the other earliest version to 0.45.0rc1 * Propose title for unrelesed notes * Update docs/release_notes.rst Co-authored-by: Matthew Treinish <mtreinish@kortar.org> --------- Co-authored-by: Matthew Treinish <mtreinish@kortar.org> Co-authored-by: Elena Peña Tapia <epenatap@gmail.com> Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
2023-12-02 19:37:50 +08:00
:earliest-version: 0.45.0rc1
.. release-notes::
:earliest-version: 0.45.0
:branch: stable/0.46
.. release-notes::
:earliest-version: 0.45.0
:branch: stable/0.45