Add patch release notes and docs fixes (qiskit-community#1412)

### Summary Closes qiskit-community#1401. Our release notes currently doesn't include notes of the patch releases before the most recent minor release. This PR updates `release_notes.rst` to build previous patch releases (0.3.1 isn't rendering but I think it's too old to be useful now anyways). The new process prior to release is that release notes from the most recent minor version's patch releases should be deleted from the main branch prior to a new minor release, and `release_notes.rst` needs to have a new directive added for the previous stable branch. ### Details and comments A few other minor changes: - Wraps the output text of jupyter-sphinx blocks - Update the contributor guide to include release note subcategories - Suppress the debugger warning during the docs build by setting `PYDEVD_DISABLE_FILE_VALIDATION=1` - Add a link to the main branch to the dev docs banner -
Naohnakazawa · Feb 19, 2024 · 0bbd426 · 0bbd426
1 parent aa3b54f
commit 0bbd426
Show file tree

Hide file tree

Showing 17 changed files with 34 additions and 87 deletions.
diff --git a/.github/workflows/docs_stable.yml b/.github/workflows/docs_stable.yml
@@ -25,7 +25,7 @@ jobs:
       - name: Build docs stable
         env:
           QISKIT_DOCS_BUILD_TUTORIALS: 'always'
-        run: EXPERIMENTS_DEV_DOCS=1 PROD_BUILD=1 tox -e docs
+        run: PROD_BUILD=1 tox -e docs
       - name: Bypass Jekyll Processing # Necessary for setting the correct css path
         run: touch docs/_build/html/.nojekyll
       - name: Set current version

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -241,7 +241,7 @@ you aren't using and update the contents for those you are. For example, the end
 should look something like:
 
 ```yaml
-features:
+features_expclass:
   - |
     Introduced a new feature foo that adds support for doing something to
     :class:`~qiskit.circuit.QuantumCircuit` objects. It can be used by using the foo function,
@@ -272,7 +272,10 @@ deprecations:
     :func:`qiskit.bar.foobar` calls to :func:`qiskit.foo`.
 ```
 
-You can also look at existing release notes for more examples.
+Note that we are using subsections within the `features`, `upgrade`, and `fixes` sections to
+organize the notes by functional area. We strongly encourage you to file your note under the most
+appropriate category. You can see the current list of categories in
+[release_notes/config.yaml](https://github.com/Qiskit-Extensions/qiskit-experiments/blob/main/releasenotes/config.yaml).
 
 You can use any restructured text feature in them (code sections, tables, enumerated
 lists, bulleted list, etc.) to express what is being changed as needed. In general, you

diff --git a/docs/_static/dataframe.css → docs/_static/customstyles.css b/docs/_static/dataframe.css → docs/_static/customstyles.css
@@ -1,3 +1,9 @@
+/* Wrap text of jupyter-sphinx output blocks */
+
+div.output pre{
+    white-space: pre-wrap;
+}
+
 /* Styling for pandas dataframes in documentation */
 
 div.output table {

diff --git a/docs/conf.py b/docs/conf.py
@@ -80,7 +80,7 @@
 templates_path = ["_templates"]
 # Manually add the gallery CSS file for now
 # TODO: Figure out why the styling is not working by default
-html_css_files = ["nbsphinx-gallery.css", "dataframe.css"]
+html_css_files = ["nbsphinx-gallery.css", "customstyles.css"]
 
 nbsphinx_timeout = 360
 nbsphinx_execute = os.getenv("QISKIT_DOCS_BUILD_TUTORIALS", "never")
@@ -176,7 +176,8 @@
 if os.getenv("EXPERIMENTS_DEV_DOCS", None):
     rst_prolog = """
 .. note::
-    This is the documentation for the current state of the development branch
+    This is the documentation for the current state of the `development branch 
+    <https://github.com/Qiskit-Extensions/qiskit-experiments/tree/main>`_
     of Qiskit Experiments. The documentation or APIs here can change prior to being
     released.
 """

diff --git a/docs/release_notes.rst b/docs/release_notes.rst
@@ -1 +1,9 @@
-.. release-notes:: Release Notes
+=============
+Release Notes
+=============
+
+.. release-notes::
+   :earliest-version: 0.6.0
+
+.. release-notes::
+   :branch: stable/0.5
diff --git a/docs/tutorials/visualization.rst b/docs/tutorials/visualization.rst
@@ -78,12 +78,6 @@ The plotter that generated the figure can be accessed through the analysis insta
 and customizing the figure can be done by setting the plotter's options. We now modify
 the color, symbols, and size of our plot, as well as change the axis labels for the amplitude units:
 
-.. jupyter-execute::
-    :hide-code:
-    :hide-output:
-
-    %matplotlib inline
-
 .. jupyter-execute::
 
     # Retrieve the plotter from the analysis instance
@@ -185,7 +179,7 @@ were styled differently according to the ``series_params`` attribute of ``figure
 
 By default, the supported figure options are ``xlabel``, ``ylabel``, ``xlim``, ``ylim``,
 ``xval_unit``, ``yval_unit``, ``xval_unit_scale``, ``yval_unit_scale``, ``xscale``, ``yscale``,
-``figure_title``, and ``series_params``; see `:class:.MplDrawer` for details on how to set these
+``figure_title``, and ``series_params``; see :class:`.MplDrawer` for details on how to set these
 options. The following T1 experiment provides examples to options that have not been demonstrated
 until now in this tutorial:
 

diff --git a/qiskit_experiments/framework/base_analysis.py b/qiskit_experiments/framework/base_analysis.py
@@ -256,7 +256,7 @@ def _run_analysis(
 
         Returns:
             A pair ``(analysis_results, figures)`` where ``analysis_results``
-            is a list of :class:`AnalysisResultData` objects, and ``figures``
+            is a list of :class:`.AnalysisResultData` objects, and ``figures``
             is a list of any figures for the experiment.
 
         Raises:

diff --git a/releasenotes/config.yaml b/releasenotes/config.yaml
@@ -4,7 +4,7 @@ default_branch: main
 sections:
   - [features, New Features, 1]
   - [features_expnew, New Experiments, 2]
-  - [features_explib, Experiment Library Updates, 2]
+  - [features_explib, Experiment Library Features, 2]
   - [features_expclass, Experiment Class Features, 2]
   - [features_analysis, Analysis Class Features, 2]
   - [features_expdata, Experiment Data Features, 2]

diff --git a/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml b/releasenotes/notes/0.6/attach-other-cals-2f539e7799ceb6c8.yaml
diff --git a/releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml b/releasenotes/notes/0.6/backend-in-rough-frequency-cal-8582610249e2327b.yaml
diff --git a/releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml b/releasenotes/notes/0.6/cals-no-coupling-map-5114ae9faa2f9e69.yaml
diff --git a/releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml b/releasenotes/notes/0.6/fix-curve-fit-weights-fb43d3aa5ed1c91c.yaml
diff --git a/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml b/releasenotes/notes/0.6/irb-circuit-order-619845a707519c44.yaml
diff --git a/releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml b/releasenotes/notes/0.6/matplotlib-fix-58d938b49771cf17.yaml
diff --git a/releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml b/releasenotes/notes/0.6/rb-v2-none-coupling-fda2b22afdef507b.yaml
diff --git a/releasenotes/notes/0.6/remove-tomo-reset-3f21ec4d0dacba91.yaml b/releasenotes/notes/0.6/remove-tomo-reset-3f21ec4d0dacba91.yaml
diff --git a/tox.ini b/tox.ini
@@ -72,6 +72,8 @@ passenv =
 deps =
   {[testenv]deps}
   pyarrow
+setenv = 
+  PYDEVD_DISABLE_FILE_VALIDATION = 1
 commands =
   sphinx-build -T -W --keep-going -b html {posargs} docs/ docs/_build/html
 
@@ -85,6 +87,8 @@ passenv =
 deps =
   {[testenv]deps}
   pyarrow
+setenv = 
+  PYDEVD_DISABLE_FILE_VALIDATION = 1
 commands =
   sphinx-build -j auto -T -W --keep-going -b html {posargs} docs/ docs/_build/html
 
@@ -100,6 +104,7 @@ deps =
   pyarrow
 setenv = 
   QISKIT_DOCS_SKIP_EXECUTE = 1
+  PYDEVD_DISABLE_FILE_VALIDATION = 1
 commands =
   sphinx-build -T -W --keep-going -b html {posargs} docs/ docs/_build/html
 
@@ -114,6 +119,8 @@ deps =
   {[testenv]deps}
   git+https://github.com/Qiskit/qiskit
   pyarrow
+setenv =
+  PYDEVD_DISABLE_FILE_VALIDATION = 1
 commands =
   sphinx-build -j auto -T -W --keep-going -b html {posargs} docs/ docs/_build/html