Skip to content

Commit 36301ab

Browse files
committed
resolved some merge conflicts
2 parents 34e2cb7 + 622554d commit 36301ab

File tree

165 files changed

+6967
-6261
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

165 files changed

+6967
-6261
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Qiskit Experiments are documented below.
2222
* [Linking to issues](#linking-to-issues)
2323
- [Generating release notes](#generating-release-notes)
2424
+ [Documentation](#documentation)
25-
+ [Experiment class documentation](#experiment-class-documenation)
25+
+ [Experiment class documentation](#experiment-class-documentation)
2626
+ [Analysis class documentation](#analysis-class-documentation)
2727
+ [Populating the table of contents](#populating-the-table-of-contents)
2828
+ [Updating the tutorials](#updating-the-tutorials)
@@ -106,34 +106,33 @@ an isolated virtualenv for running tests. This means it does not pollute your sy
106106
python when running. Additionally, the environment that tox sets up matches the CI
107107
environment more closely and it runs the tests in parallel (resulting in much faster
108108
execution). To run tests on all installed supported python versions and lint/style
109-
checks you can simply run `tox`. Or if you just want to run the tests once run for a
110-
specific python version: `tox -epy37` (or replace py37 with the python version you want
111-
to use, py35 or py36).
109+
checks you can simply run `tox`. Or if you just want to run the tests once for a
110+
specific python version such as 3.10: `tox -epy310`.
112111

113112
If you just want to run a subset of tests you can pass a selection regex to the test
114113
runner. For example, if you want to run all tests that have "dag" in the test id you can
115-
run: `tox -epy37 -- dag`. You can pass arguments directly to the test runner after the
114+
run: `tox -- dag`. You can pass arguments directly to the test runner after the
116115
bare `--`. To see all the options on test selection you can refer to the stestr manual:
117116
https://stestr.readthedocs.io/en/stable/MANUAL.html#test-selection
118117

119118
If you want to run a single test module, test class, or individual test method you can
120119
do this faster with the `-n`/`--no-discover` option. For example, to run a module:
121120
```
122-
tox -epy37 -- -n test.python.test_examples
121+
tox -- -n test.python.test_examples
123122
```
124123
Or to run the same module by path:
125124

126125
```
127-
tox -epy37 -- -n test/python/test_examples.py
126+
tox -- -n test/python/test_examples.py
128127
```
129128
To run a class:
130129

131130
```
132-
tox -epy37 -- -n test.python.test_examples.TestPythonExamples
131+
tox -- -n test.python.test_examples.TestPythonExamples
133132
```
134133
To run a method:
135134
```
136-
tox -epy37 -- -n test.python.test_examples.TestPythonExamples.test_all_examples
135+
tox -- -n test.python.test_examples.TestPythonExamples.test_all_examples
137136
```
138137

139138
#### STDOUT/STDERR and logging capture
@@ -312,7 +311,7 @@ formatted in the same manner throughout our experiment library. You can use stan
312311
[reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html)
313312
directives along with our syntax.
314313

315-
#### Experiment class documenation
314+
#### Experiment class documentation
316315

317316
You should complete or update the class documentation and method documentation for
318317
`_default_experiment_options`. You can use several predefined sections for the class docstring.
@@ -432,7 +431,7 @@ You can use the same syntax and section headers for the analysis class documenta
432431
variable names shown in analysis results. You can write symbol :math:`a` here too.
433432
434433
# section: fit_parameters
435-
Optional. Description for fit parametres in the model.
434+
Optional. Description for fit parameters in the model.
436435
You can also write how initial guess is generated and how fit bound is determined.
437436
438437
defpar a:
@@ -559,7 +558,7 @@ to the user, use the `:hide-code:` and `:hide-output:` directives:
559558
:hide-output:
560559

561560
from qiskit.test.ibmq_mock import mock_get_backend
562-
backend = mock_get_backend('FakeArmonk')
561+
backend = mock_get_backend('FakeLima')
563562

564563
To ignore an error from a Jupyter cell block, use the `:raises:` directive.
565564
#### Building documentation locally

docs/_ext/custom_styles/formatter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ def format_analysis_opts(self, lines: List[str]) -> List[str]:
133133
format_lines = [
134134
".. rubric:: Analysis Options",
135135
"",
136-
"These options can be set by :py:meth:`set_analysis_options` method.",
136+
"These options can be set by :py:meth:`analysis.set_options` method.",
137137
"",
138138
]
139139
format_lines.extend(lines)

docs/conf.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,12 @@
2828

2929
sys.path.insert(0, os.path.abspath("."))
3030
sys.path.append(os.path.abspath("./_ext"))
31+
sys.path.append(os.path.abspath(".."))
3132

3233
"""
3334
Sphinx documentation builder
3435
"""
3536

36-
import os
37-
3837
# Set env flag so that we can doc functions that may otherwise not be loaded
3938
# see for example interactive visualizations in qiskit.visualization.
4039
os.environ["QISKIT_DOCS"] = "TRUE"
@@ -45,9 +44,9 @@
4544
author = "Qiskit Development Team"
4645

4746
# The short X.Y version
48-
version = "0.4"
47+
version = "0.5"
4948
# The full version, including alpha/beta/rc tags
50-
release = "0.4.0"
49+
release = "0.5.0"
5150

5251
rst_prolog = """
5352
.. raw:: html
@@ -141,7 +140,7 @@
141140
#
142141
# This is also used if you do content translation via gettext catalogs.
143142
# Usually you set "language" from the command line for these cases.
144-
language = None
143+
language = "en"
145144

146145
# List of patterns, relative to source directory, that match files and
147146
# directories to ignore when looking for source files.
@@ -184,10 +183,10 @@
184183
}
185184

186185

187-
autoclass_content = 'both'
186+
autoclass_content = "both"
188187
intersphinx_mapping = {
189-
'matplotlib': ('https://matplotlib.org/stable/', None),
190-
'qiskit': ('https://qiskit.org/documentation/', None),
188+
"matplotlib": ("https://matplotlib.org/stable/", None),
189+
"qiskit": ("https://qiskit.org/documentation/", None),
191190
}
192191

193192

docs/release_notes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
.. release-notes:: Release Notes
1+
.. release-notes:: Release Notes

docs/tutorials/GUIDELINES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Below are more concrete guidelines pertaining to various tutorial aspects:
2525
* For sub titles of how-to steps - use present progressive. E.e. "Saving exp data to the DB" (instead of "Save exp data to the DB")
2626
* Use math notation as much as possible (e.g. use $\frac{\pi}{2}$ instead of pi-half or pi/2)
2727
* Use headers, subheaders, subsubheaders etc. for hierarchical text organization. No need to number the headers
28-
* Use device names as shown in the IBM Quantum Services dashboard, e.g. ibmq_armonk instead of IBMQ Armonk
28+
* Use device names as shown in the IBM Quantum Services dashboard, e.g. ibmq_lima instead of IBMQ Lima
2929
* put identifier names (e.g. osc_freq) in code blocks using backticks, i.e. `osc_freq`
3030

3131
## Content guidelines

0 commit comments

Comments
 (0)