diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 3d111e0c7b9e..4405456d76bc 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -53,7 +53,7 @@ jobs: python -m pip install -U 'tox<4' python -m pip install -r requirements-dev.txt - name: Build Docs - run: tox -edocs -- -j auto + run: tox -edocs - name: Compress Artifacts run: | mkdir artifacts diff --git a/docs/aer_sources.txt b/docs/aer_sources.txt deleted file mode 100644 index 42d203664b6d..000000000000 --- a/docs/aer_sources.txt +++ /dev/null @@ -1,574 +0,0 @@ -stubs/qiskit.providers.aer.AerError.html -stubs/qiskit.providers.aer.AerProvider.backends.html -stubs/qiskit.providers.aer.AerProvider.get_backend.html -stubs/qiskit.providers.aer.AerProvider.html -stubs/qiskit.providers.aer.AerSimulator.available_devices.html -stubs/qiskit.providers.aer.AerSimulator.available_methods.html -stubs/qiskit.providers.aer.AerSimulator.clear_options.html -stubs/qiskit.providers.aer.AerSimulator.configuration.html -stubs/qiskit.providers.aer.AerSimulator.defaults.html -stubs/qiskit.providers.aer.AerSimulator.from_backend.html -stubs/qiskit.providers.aer.AerSimulator.html -stubs/qiskit.providers.aer.AerSimulator.name.html -stubs/qiskit.providers.aer.AerSimulator.properties.html -stubs/qiskit.providers.aer.AerSimulator.provider.html -stubs/qiskit.providers.aer.AerSimulator.run.html -stubs/qiskit.providers.aer.AerSimulator.set_option.html -stubs/qiskit.providers.aer.AerSimulator.set_options.html -stubs/qiskit.providers.aer.AerSimulator.status.html -stubs/qiskit.providers.aer.extensions.Snapshot.add_decomposition.html -stubs/qiskit.providers.aer.extensions.Snapshot.assemble.html -stubs/qiskit.providers.aer.extensions.Snapshot.broadcast_arguments.html -stubs/qiskit.providers.aer.extensions.Snapshot.c_if.html -stubs/qiskit.providers.aer.extensions.Snapshot.copy.html -stubs/qiskit.providers.aer.extensions.Snapshot.define_snapshot_register.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.add_decomposition.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.assemble.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.broadcast_arguments.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.c_if.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.copy.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.define_snapshot_register.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.inverse.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.is_parameterized.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.qasm.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.repeat.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.reverse_ops.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.soft_compare.html -stubs/qiskit.providers.aer.extensions.SnapshotDensityMatrix.validate_parameter.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.add_decomposition.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.assemble.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.broadcast_arguments.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.c_if.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.copy.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.define_snapshot_register.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.inverse.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.is_parameterized.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.qasm.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.repeat.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.reverse_ops.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.soft_compare.html -stubs/qiskit.providers.aer.extensions.SnapshotExpectationValue.validate_parameter.html -stubs/qiskit.providers.aer.extensions.Snapshot.html -stubs/qiskit.providers.aer.extensions.Snapshot.inverse.html -stubs/qiskit.providers.aer.extensions.Snapshot.is_parameterized.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.add_decomposition.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.assemble.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.broadcast_arguments.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.c_if.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.copy.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.define_snapshot_register.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.inverse.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.is_parameterized.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.qasm.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.repeat.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.reverse_ops.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.soft_compare.html -stubs/qiskit.providers.aer.extensions.SnapshotProbabilities.validate_parameter.html -stubs/qiskit.providers.aer.extensions.Snapshot.qasm.html -stubs/qiskit.providers.aer.extensions.Snapshot.repeat.html -stubs/qiskit.providers.aer.extensions.Snapshot.reverse_ops.html -stubs/qiskit.providers.aer.extensions.Snapshot.soft_compare.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.add_decomposition.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.assemble.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.broadcast_arguments.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.c_if.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.copy.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.define_snapshot_register.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.inverse.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.is_parameterized.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.qasm.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.repeat.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.reverse_ops.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.soft_compare.html -stubs/qiskit.providers.aer.extensions.SnapshotStabilizer.validate_parameter.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.add_decomposition.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.assemble.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.broadcast_arguments.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.c_if.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.copy.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.define_snapshot_register.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.inverse.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.is_parameterized.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.qasm.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.repeat.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.reverse_ops.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.soft_compare.html -stubs/qiskit.providers.aer.extensions.SnapshotStatevector.validate_parameter.html -stubs/qiskit.providers.aer.extensions.Snapshot.validate_parameter.html -stubs/qiskit.providers.aer.jobs.AerJob.backend.html -stubs/qiskit.providers.aer.jobs.AerJob.cancel.html -stubs/qiskit.providers.aer.jobs.AerJob.cancelled.html -stubs/qiskit.providers.aer.jobs.AerJob.done.html -stubs/qiskit.providers.aer.jobs.AerJob.executor.html -stubs/qiskit.providers.aer.jobs.AerJob.html -stubs/qiskit.providers.aer.jobs.AerJob.in_final_state.html -stubs/qiskit.providers.aer.jobs.AerJob.job_id.html -stubs/qiskit.providers.aer.jobs.AerJob.qobj.html -stubs/qiskit.providers.aer.jobs.AerJob.result.html -stubs/qiskit.providers.aer.jobs.AerJob.running.html -stubs/qiskit.providers.aer.jobs.AerJobSet.backend.html -stubs/qiskit.providers.aer.jobs.AerJobSet.cancel.html -stubs/qiskit.providers.aer.jobs.AerJobSet.cancelled.html -stubs/qiskit.providers.aer.jobs.AerJobSet.done.html -stubs/qiskit.providers.aer.jobs.AerJobSet.executor.html -stubs/qiskit.providers.aer.jobs.AerJobSet.html -stubs/qiskit.providers.aer.jobs.AerJobSet.in_final_state.html -stubs/qiskit.providers.aer.jobs.AerJobSet.job.html -stubs/qiskit.providers.aer.jobs.AerJobSet.job_id.html -stubs/qiskit.providers.aer.jobs.AerJobSet.result.html -stubs/qiskit.providers.aer.jobs.AerJobSet.running.html -stubs/qiskit.providers.aer.jobs.AerJobSet.status.html -stubs/qiskit.providers.aer.jobs.AerJobSet.submit.html -stubs/qiskit.providers.aer.jobs.AerJobSet.wait_for_final_state.html -stubs/qiskit.providers.aer.jobs.AerJobSet.worker.html -stubs/qiskit.providers.aer.jobs.AerJobSet.worker_job.html -stubs/qiskit.providers.aer.jobs.AerJobSet.worker_results.html -stubs/qiskit.providers.aer.jobs.AerJob.status.html -stubs/qiskit.providers.aer.jobs.AerJob.submit.html -stubs/qiskit.providers.aer.jobs.AerJob.wait_for_final_state.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.assemble.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.c_if.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.copy.html -stubs/qiskit.providers.aer.library.save_amplitudes.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.inverse.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.qasm.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.repeat.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.soft_compare.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.assemble.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.c_if.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.copy.html -stubs/qiskit.providers.aer.library.save_amplitudes_squared.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.inverse.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.qasm.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.repeat.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.soft_compare.html -stubs/qiskit.providers.aer.library.SaveAmplitudesSquared.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveAmplitudes.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveClifford.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveClifford.assemble.html -stubs/qiskit.providers.aer.library.SaveClifford.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveClifford.c_if.html -stubs/qiskit.providers.aer.library.SaveClifford.copy.html -stubs/qiskit.providers.aer.library.save_clifford.html -stubs/qiskit.providers.aer.library.SaveClifford.html -stubs/qiskit.providers.aer.library.SaveClifford.inverse.html -stubs/qiskit.providers.aer.library.SaveClifford.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveClifford.qasm.html -stubs/qiskit.providers.aer.library.SaveClifford.repeat.html -stubs/qiskit.providers.aer.library.SaveClifford.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveClifford.soft_compare.html -stubs/qiskit.providers.aer.library.SaveClifford.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.assemble.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.c_if.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.copy.html -stubs/qiskit.providers.aer.library.save_density_matrix.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.inverse.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.qasm.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.repeat.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.soft_compare.html -stubs/qiskit.providers.aer.library.SaveDensityMatrix.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.assemble.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.c_if.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.copy.html -stubs/qiskit.providers.aer.library.save_expectation_value.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.inverse.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.qasm.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.repeat.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.soft_compare.html -stubs/qiskit.providers.aer.library.SaveExpectationValue.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.assemble.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.c_if.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.copy.html -stubs/qiskit.providers.aer.library.save_expectation_value_variance.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.inverse.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.qasm.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.repeat.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.soft_compare.html -stubs/qiskit.providers.aer.library.SaveExpectationValueVariance.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.assemble.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.c_if.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.copy.html -stubs/qiskit.providers.aer.library.save_matrix_product_state.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.inverse.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.qasm.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.repeat.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.soft_compare.html -stubs/qiskit.providers.aer.library.SaveMatrixProductState.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveProbabilities.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveProbabilities.assemble.html -stubs/qiskit.providers.aer.library.SaveProbabilities.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveProbabilities.c_if.html -stubs/qiskit.providers.aer.library.SaveProbabilities.copy.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.assemble.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.c_if.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.copy.html -stubs/qiskit.providers.aer.library.save_probabilities_dict.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.inverse.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.qasm.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.repeat.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.soft_compare.html -stubs/qiskit.providers.aer.library.SaveProbabilitiesDict.validate_parameter.html -stubs/qiskit.providers.aer.library.save_probabilities.html -stubs/qiskit.providers.aer.library.SaveProbabilities.html -stubs/qiskit.providers.aer.library.SaveProbabilities.inverse.html -stubs/qiskit.providers.aer.library.SaveProbabilities.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveProbabilities.qasm.html -stubs/qiskit.providers.aer.library.SaveProbabilities.repeat.html -stubs/qiskit.providers.aer.library.SaveProbabilities.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveProbabilities.soft_compare.html -stubs/qiskit.providers.aer.library.SaveProbabilities.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveStabilizer.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveStabilizer.assemble.html -stubs/qiskit.providers.aer.library.SaveStabilizer.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveStabilizer.c_if.html -stubs/qiskit.providers.aer.library.SaveStabilizer.copy.html -stubs/qiskit.providers.aer.library.save_stabilizer.html -stubs/qiskit.providers.aer.library.SaveStabilizer.html -stubs/qiskit.providers.aer.library.SaveStabilizer.inverse.html -stubs/qiskit.providers.aer.library.SaveStabilizer.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveStabilizer.qasm.html -stubs/qiskit.providers.aer.library.SaveStabilizer.repeat.html -stubs/qiskit.providers.aer.library.SaveStabilizer.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveStabilizer.soft_compare.html -stubs/qiskit.providers.aer.library.SaveStabilizer.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveState.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveState.assemble.html -stubs/qiskit.providers.aer.library.SaveState.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveState.c_if.html -stubs/qiskit.providers.aer.library.SaveState.copy.html -stubs/qiskit.providers.aer.library.save_state.html -stubs/qiskit.providers.aer.library.SaveState.html -stubs/qiskit.providers.aer.library.SaveState.inverse.html -stubs/qiskit.providers.aer.library.SaveState.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveState.qasm.html -stubs/qiskit.providers.aer.library.SaveState.repeat.html -stubs/qiskit.providers.aer.library.SaveState.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveState.soft_compare.html -stubs/qiskit.providers.aer.library.SaveState.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveStatevector.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveStatevector.assemble.html -stubs/qiskit.providers.aer.library.SaveStatevector.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveStatevector.c_if.html -stubs/qiskit.providers.aer.library.SaveStatevector.copy.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.assemble.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.c_if.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.copy.html -stubs/qiskit.providers.aer.library.save_statevector_dict.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.inverse.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.qasm.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.repeat.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.soft_compare.html -stubs/qiskit.providers.aer.library.SaveStatevectorDict.validate_parameter.html -stubs/qiskit.providers.aer.library.save_statevector.html -stubs/qiskit.providers.aer.library.SaveStatevector.html -stubs/qiskit.providers.aer.library.SaveStatevector.inverse.html -stubs/qiskit.providers.aer.library.SaveStatevector.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveStatevector.qasm.html -stubs/qiskit.providers.aer.library.SaveStatevector.repeat.html -stubs/qiskit.providers.aer.library.SaveStatevector.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveStatevector.soft_compare.html -stubs/qiskit.providers.aer.library.SaveStatevector.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveSuperOp.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveSuperOp.assemble.html -stubs/qiskit.providers.aer.library.SaveSuperOp.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveSuperOp.c_if.html -stubs/qiskit.providers.aer.library.SaveSuperOp.copy.html -stubs/qiskit.providers.aer.library.save_superop.html -stubs/qiskit.providers.aer.library.SaveSuperOp.html -stubs/qiskit.providers.aer.library.SaveSuperOp.inverse.html -stubs/qiskit.providers.aer.library.SaveSuperOp.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveSuperOp.qasm.html -stubs/qiskit.providers.aer.library.SaveSuperOp.repeat.html -stubs/qiskit.providers.aer.library.SaveSuperOp.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveSuperOp.soft_compare.html -stubs/qiskit.providers.aer.library.SaveSuperOp.validate_parameter.html -stubs/qiskit.providers.aer.library.SaveUnitary.add_decomposition.html -stubs/qiskit.providers.aer.library.SaveUnitary.assemble.html -stubs/qiskit.providers.aer.library.SaveUnitary.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SaveUnitary.c_if.html -stubs/qiskit.providers.aer.library.SaveUnitary.copy.html -stubs/qiskit.providers.aer.library.save_unitary.html -stubs/qiskit.providers.aer.library.SaveUnitary.html -stubs/qiskit.providers.aer.library.SaveUnitary.inverse.html -stubs/qiskit.providers.aer.library.SaveUnitary.is_parameterized.html -stubs/qiskit.providers.aer.library.SaveUnitary.qasm.html -stubs/qiskit.providers.aer.library.SaveUnitary.repeat.html -stubs/qiskit.providers.aer.library.SaveUnitary.reverse_ops.html -stubs/qiskit.providers.aer.library.SaveUnitary.soft_compare.html -stubs/qiskit.providers.aer.library.SaveUnitary.validate_parameter.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.add_decomposition.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.assemble.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.c_if.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.copy.html -stubs/qiskit.providers.aer.library.set_density_matrix.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.inverse.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.is_parameterized.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.qasm.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.repeat.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.reverse_ops.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.soft_compare.html -stubs/qiskit.providers.aer.library.SetDensityMatrix.validate_parameter.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.add_decomposition.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.assemble.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.c_if.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.copy.html -stubs/qiskit.providers.aer.library.set_matrix_product_state.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.inverse.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.is_parameterized.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.qasm.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.repeat.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.reverse_ops.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.soft_compare.html -stubs/qiskit.providers.aer.library.SetMatrixProductState.validate_parameter.html -stubs/qiskit.providers.aer.library.SetStabilizer.add_decomposition.html -stubs/qiskit.providers.aer.library.SetStabilizer.assemble.html -stubs/qiskit.providers.aer.library.SetStabilizer.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SetStabilizer.c_if.html -stubs/qiskit.providers.aer.library.SetStabilizer.copy.html -stubs/qiskit.providers.aer.library.set_stabilizer.html -stubs/qiskit.providers.aer.library.SetStabilizer.html -stubs/qiskit.providers.aer.library.SetStabilizer.inverse.html -stubs/qiskit.providers.aer.library.SetStabilizer.is_parameterized.html -stubs/qiskit.providers.aer.library.SetStabilizer.qasm.html -stubs/qiskit.providers.aer.library.SetStabilizer.repeat.html -stubs/qiskit.providers.aer.library.SetStabilizer.reverse_ops.html -stubs/qiskit.providers.aer.library.SetStabilizer.soft_compare.html -stubs/qiskit.providers.aer.library.SetStabilizer.validate_parameter.html -stubs/qiskit.providers.aer.library.SetStatevector.add_decomposition.html -stubs/qiskit.providers.aer.library.SetStatevector.assemble.html -stubs/qiskit.providers.aer.library.SetStatevector.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SetStatevector.c_if.html -stubs/qiskit.providers.aer.library.SetStatevector.copy.html -stubs/qiskit.providers.aer.library.set_statevector.html -stubs/qiskit.providers.aer.library.SetStatevector.html -stubs/qiskit.providers.aer.library.SetStatevector.inverse.html -stubs/qiskit.providers.aer.library.SetStatevector.is_parameterized.html -stubs/qiskit.providers.aer.library.SetStatevector.qasm.html -stubs/qiskit.providers.aer.library.SetStatevector.repeat.html -stubs/qiskit.providers.aer.library.SetStatevector.reverse_ops.html -stubs/qiskit.providers.aer.library.SetStatevector.soft_compare.html -stubs/qiskit.providers.aer.library.SetStatevector.validate_parameter.html -stubs/qiskit.providers.aer.library.SetSuperOp.add_decomposition.html -stubs/qiskit.providers.aer.library.SetSuperOp.assemble.html -stubs/qiskit.providers.aer.library.SetSuperOp.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SetSuperOp.c_if.html -stubs/qiskit.providers.aer.library.SetSuperOp.copy.html -stubs/qiskit.providers.aer.library.set_superop.html -stubs/qiskit.providers.aer.library.SetSuperOp.html -stubs/qiskit.providers.aer.library.SetSuperOp.inverse.html -stubs/qiskit.providers.aer.library.SetSuperOp.is_parameterized.html -stubs/qiskit.providers.aer.library.SetSuperOp.qasm.html -stubs/qiskit.providers.aer.library.SetSuperOp.repeat.html -stubs/qiskit.providers.aer.library.SetSuperOp.reverse_ops.html -stubs/qiskit.providers.aer.library.SetSuperOp.soft_compare.html -stubs/qiskit.providers.aer.library.SetSuperOp.validate_parameter.html -stubs/qiskit.providers.aer.library.SetUnitary.add_decomposition.html -stubs/qiskit.providers.aer.library.SetUnitary.assemble.html -stubs/qiskit.providers.aer.library.SetUnitary.broadcast_arguments.html -stubs/qiskit.providers.aer.library.SetUnitary.c_if.html -stubs/qiskit.providers.aer.library.SetUnitary.copy.html -stubs/qiskit.providers.aer.library.set_unitary.html -stubs/qiskit.providers.aer.library.SetUnitary.html -stubs/qiskit.providers.aer.library.SetUnitary.inverse.html -stubs/qiskit.providers.aer.library.SetUnitary.is_parameterized.html -stubs/qiskit.providers.aer.library.SetUnitary.qasm.html -stubs/qiskit.providers.aer.library.SetUnitary.repeat.html -stubs/qiskit.providers.aer.library.SetUnitary.reverse_ops.html -stubs/qiskit.providers.aer.library.SetUnitary.soft_compare.html -stubs/qiskit.providers.aer.library.SetUnitary.validate_parameter.html -stubs/qiskit.providers.aer.noise.amplitude_damping_error.html -stubs/qiskit.providers.aer.noise.coherent_unitary_error.html -stubs/qiskit.providers.aer.noise.depolarizing_error.html -stubs/qiskit.providers.aer.noise.device.basic_device_gate_errors.html -stubs/qiskit.providers.aer.noise.device.basic_device_readout_errors.html -stubs/qiskit.providers.aer.noise.device.gate_error_values.html -stubs/qiskit.providers.aer.noise.device.gate_length_values.html -stubs/qiskit.providers.aer.noise.device.gate_param_values.html -stubs/qiskit.providers.aer.noise.device.readout_error_values.html -stubs/qiskit.providers.aer.noise.device.thermal_relaxation_values.html -stubs/qiskit.providers.aer.noise.kraus_error.html -stubs/qiskit.providers.aer.noise.LocalNoisePass.html -stubs/qiskit.providers.aer.noise.LocalNoisePass.name.html -stubs/qiskit.providers.aer.noise.LocalNoisePass.run.html -stubs/qiskit.providers.aer.noise.mixed_unitary_error.html -stubs/qiskit.providers.aer.noise.NoiseModel.add_all_qubit_quantum_error.html -stubs/qiskit.providers.aer.noise.NoiseModel.add_all_qubit_readout_error.html -stubs/qiskit.providers.aer.noise.NoiseModel.add_basis_gates.html -stubs/qiskit.providers.aer.noise.NoiseModel.add_nonlocal_quantum_error.html -stubs/qiskit.providers.aer.noise.NoiseModel.add_quantum_error.html -stubs/qiskit.providers.aer.noise.NoiseModel.add_readout_error.html -stubs/qiskit.providers.aer.noise.NoiseModel.from_backend.html -stubs/qiskit.providers.aer.noise.NoiseModel.from_dict.html -stubs/qiskit.providers.aer.noise.NoiseModel.html -stubs/qiskit.providers.aer.noise.NoiseModel.is_ideal.html -stubs/qiskit.providers.aer.noise.NoiseModel.reset.html -stubs/qiskit.providers.aer.noise.NoiseModel.to_dict.html -stubs/qiskit.providers.aer.noise.pauli_error.html -stubs/qiskit.providers.aer.noise.phase_amplitude_damping_error.html -stubs/qiskit.providers.aer.noise.phase_damping_error.html -stubs/qiskit.providers.aer.noise.QuantumError.compose.html -stubs/qiskit.providers.aer.noise.QuantumError.copy.html -stubs/qiskit.providers.aer.noise.QuantumError.dot.html -stubs/qiskit.providers.aer.noise.QuantumError.error_term.html -stubs/qiskit.providers.aer.noise.QuantumError.expand.html -stubs/qiskit.providers.aer.noise.QuantumError.html -stubs/qiskit.providers.aer.noise.QuantumError.ideal.html -stubs/qiskit.providers.aer.noise.QuantumError.input_dims.html -stubs/qiskit.providers.aer.noise.QuantumError.output_dims.html -stubs/qiskit.providers.aer.noise.QuantumError.power.html -stubs/qiskit.providers.aer.noise.QuantumError.reshape.html -stubs/qiskit.providers.aer.noise.QuantumError.set_atol.html -stubs/qiskit.providers.aer.noise.QuantumError.set_rtol.html -stubs/qiskit.providers.aer.noise.QuantumError.tensor.html -stubs/qiskit.providers.aer.noise.QuantumError.to_dict.html -stubs/qiskit.providers.aer.noise.QuantumError.to_instruction.html -stubs/qiskit.providers.aer.noise.QuantumError.to_quantumchannel.html -stubs/qiskit.providers.aer.noise.ReadoutError.compose.html -stubs/qiskit.providers.aer.noise.ReadoutError.copy.html -stubs/qiskit.providers.aer.noise.ReadoutError.dot.html -stubs/qiskit.providers.aer.noise.ReadoutError.expand.html -stubs/qiskit.providers.aer.noise.ReadoutError.html -stubs/qiskit.providers.aer.noise.ReadoutError.ideal.html -stubs/qiskit.providers.aer.noise.ReadoutError.power.html -stubs/qiskit.providers.aer.noise.ReadoutError.set_atol.html -stubs/qiskit.providers.aer.noise.ReadoutError.set_rtol.html -stubs/qiskit.providers.aer.noise.ReadoutError.tensor.html -stubs/qiskit.providers.aer.noise.ReadoutError.to_dict.html -stubs/qiskit.providers.aer.noise.ReadoutError.to_instruction.html -stubs/qiskit.providers.aer.noise.RelaxationNoisePass.html -stubs/qiskit.providers.aer.noise.RelaxationNoisePass.name.html -stubs/qiskit.providers.aer.noise.RelaxationNoisePass.run.html -stubs/qiskit.providers.aer.noise.reset_error.html -stubs/qiskit.providers.aer.noise.thermal_relaxation_error.html -stubs/qiskit.providers.aer.pulse.duffing_system_model.html -stubs/qiskit.providers.aer.pulse.PulseSystemModel.calculate_channel_frequencies.html -stubs/qiskit.providers.aer.pulse.PulseSystemModel.control_channel_index.html -stubs/qiskit.providers.aer.pulse.PulseSystemModel.from_backend.html -stubs/qiskit.providers.aer.pulse.PulseSystemModel.from_config.html -stubs/qiskit.providers.aer.pulse.PulseSystemModel.html -stubs/qiskit.providers.aer.PulseSimulator.clear_options.html -stubs/qiskit.providers.aer.PulseSimulator.configuration.html -stubs/qiskit.providers.aer.PulseSimulator.defaults.html -stubs/qiskit.providers.aer.PulseSimulator.from_backend.html -stubs/qiskit.providers.aer.PulseSimulator.html -stubs/qiskit.providers.aer.PulseSimulator.name.html -stubs/qiskit.providers.aer.PulseSimulator.properties.html -stubs/qiskit.providers.aer.PulseSimulator.provider.html -stubs/qiskit.providers.aer.PulseSimulator.run.html -stubs/qiskit.providers.aer.PulseSimulator.set_option.html -stubs/qiskit.providers.aer.PulseSimulator.set_options.html -stubs/qiskit.providers.aer.PulseSimulator.status.html -stubs/qiskit.providers.aer.QasmSimulator.available_devices.html -stubs/qiskit.providers.aer.QasmSimulator.available_methods.html -stubs/qiskit.providers.aer.QasmSimulator.clear_options.html -stubs/qiskit.providers.aer.QasmSimulator.configuration.html -stubs/qiskit.providers.aer.QasmSimulator.defaults.html -stubs/qiskit.providers.aer.QasmSimulator.from_backend.html -stubs/qiskit.providers.aer.QasmSimulator.html -stubs/qiskit.providers.aer.QasmSimulator.name.html -stubs/qiskit.providers.aer.QasmSimulator.properties.html -stubs/qiskit.providers.aer.QasmSimulator.provider.html -stubs/qiskit.providers.aer.QasmSimulator.run.html -stubs/qiskit.providers.aer.QasmSimulator.set_option.html -stubs/qiskit.providers.aer.QasmSimulator.set_options.html -stubs/qiskit.providers.aer.QasmSimulator.status.html -stubs/qiskit.providers.aer.StatevectorSimulator.available_devices.html -stubs/qiskit.providers.aer.StatevectorSimulator.available_methods.html -stubs/qiskit.providers.aer.StatevectorSimulator.clear_options.html -stubs/qiskit.providers.aer.StatevectorSimulator.configuration.html -stubs/qiskit.providers.aer.StatevectorSimulator.defaults.html -stubs/qiskit.providers.aer.StatevectorSimulator.html -stubs/qiskit.providers.aer.StatevectorSimulator.name.html -stubs/qiskit.providers.aer.StatevectorSimulator.properties.html -stubs/qiskit.providers.aer.StatevectorSimulator.provider.html -stubs/qiskit.providers.aer.StatevectorSimulator.run.html -stubs/qiskit.providers.aer.StatevectorSimulator.set_option.html -stubs/qiskit.providers.aer.StatevectorSimulator.set_options.html -stubs/qiskit.providers.aer.StatevectorSimulator.status.html -stubs/qiskit.providers.aer.UnitarySimulator.available_devices.html -stubs/qiskit.providers.aer.UnitarySimulator.available_methods.html -stubs/qiskit.providers.aer.UnitarySimulator.clear_options.html -stubs/qiskit.providers.aer.UnitarySimulator.configuration.html -stubs/qiskit.providers.aer.UnitarySimulator.defaults.html -stubs/qiskit.providers.aer.UnitarySimulator.html -stubs/qiskit.providers.aer.UnitarySimulator.name.html -stubs/qiskit.providers.aer.UnitarySimulator.properties.html -stubs/qiskit.providers.aer.UnitarySimulator.provider.html -stubs/qiskit.providers.aer.UnitarySimulator.run.html -stubs/qiskit.providers.aer.UnitarySimulator.set_option.html -stubs/qiskit.providers.aer.UnitarySimulator.set_options.html -stubs/qiskit.providers.aer.UnitarySimulator.status.html -stubs/qiskit.providers.aer.utils.approximate_noise_model.html -stubs/qiskit.providers.aer.utils.approximate_quantum_error.html -stubs/qiskit.providers.aer.utils.insert_noise.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.channel_matrix_representation.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.compute_channel_operation.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.compute_P.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.compute_q.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.fidelity.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.flatten_matrix.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.generate_channel_matrices.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.generate_channel_quadratic_programming_matrices.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.get_const_matrix_from_channel.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.get_matrix_from_channel.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.operator_circuit.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.operator_matrix.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.prepare_channel_operator_list.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.prepare_honesty_constraint.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.solve_quadratic_program.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.transform_by_given_channel.html -stubs/qiskit.providers.aer.utils.NoiseTransformer.transform_by_operator_list.html -stubs/qiskit.providers.aer.utils.remap_noise_model.html -stubs/qiskit.providers.aer.utils.transform_noise_model.html -stubs/qiskit.providers.aer.utils.transpile_noise_model.html -stubs/qiskit.providers.aer.utils.transpile_quantum_error.html diff --git a/docs/conf.py b/docs/conf.py index 085706d44485..ada98ae2fc55 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,3 @@ -# -*- coding: utf-8 -*- - # This code is part of Qiskit. # # (C) Copyright IBM 2018. @@ -27,7 +25,7 @@ sys.path.insert(0, os.path.abspath(".")) import custom_extensions -import url_redirects +import versionutils # -- General configuration --------------------------------------------------- @@ -57,14 +55,11 @@ "sphinx.ext.extlinks", "nbsphinx", "sphinx_design", - "sphinx_reredirects", "matplotlib.sphinxext.plot_directive", "qiskit_sphinx_theme", "sphinx.ext.doctest", ] -redirects = url_redirects.determine_redirects() - nbsphinx_timeout = 300 nbsphinx_execute = os.getenv("QISKIT_DOCS_BUILD_TUTORIALS", "never") nbsphinx_widgets_path = "" @@ -217,6 +212,6 @@ def setup(app): custom_extensions.load_api_sources(app) custom_extensions.load_tutorials(app) - app.setup_extension("versionutils") + versionutils.setup(app) app.connect("build-finished", custom_extensions.clean_api_source) app.connect("build-finished", custom_extensions.clean_tutorials) diff --git a/docs/url_redirects.py b/docs/url_redirects.py deleted file mode 100644 index 5e500aaa896c..000000000000 --- a/docs/url_redirects.py +++ /dev/null @@ -1,151 +0,0 @@ -# This code is part of Qiskit. -# -# (C) Copyright IBM 2023. -# -# This code is licensed under the Apache License, Version 2.0. You may -# obtain a copy of this license in the LICENSE.txt file in the root directory -# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0. -# -# Any modifications or derivative works of this code must retain this -# copyright notice, and modified files need to carry a notice indicating -# that they have been altered from the originals. - -"""Redirects of old pages to new pages. - -See https://documatt.gitlab.io/sphinx-reredirects/usage.html for how this works. -""" - -from pathlib import Path -from typing import Dict - - -def determine_redirects() -> Dict[str, str]: - return { - "install": "getting_started.html", - "tutorials/algorithms/08_factorizers": "https://qiskit.org/textbook/ch-algorithms/shor.html", - **_redirects_for_tutorials(), - **_redirects_for_aer(), - } - - -_optimization_tutorials = [ - "1_quadratic_program", - "2_converters_for_quadratic_programs", - "3_minimum_eigen_optimizer", - "4_grover_optimizer", - "5_admm_optimizer", - "6_examples_max_cut_and_tsp", - "7_examples_vehicle_routing", - "8_cvar_optimization", - "index.html", -] - -_finance_tutorials = [ - "01_portfolio_optimization", - "02_portfolio_diversification", - "03_european_call_option_pricing", - "04_european_put_option_pricing", - "05_bull_spread_pricing", - "06_basket_option_pricing", - "07_asian_barrier_spread_pricing", - "08_fixed_income_pricing", - "09_credit_risk_analysis", - "10_qgan_option_pricing", - "11_time_series", - "index", -] - -_chemistry_tutorials = [ - "01_electronic_structure", - "02_vibronic_structure", - "03_ground_state_solvers", - "04_excited_states_solvers", - "05_Sampling_potential_energy_surfaces", - "06_calculating_thermodynamic_observables", - "index", -] - -_ml_tutorials = [ - "01_qsvm_classification", - "02_qsvm_multiclass", - "03_vqc", - "04_qgans_for_loading_random_distributions", - "index", -] - -_dynamics_tutorials = [ - "09_pulse_simulator_duffing_model", - "10_pulse_simulator_backend_model", -] - -_experiments_tutorials = [ - "1_hamiltonian_and_gate_characterization", - "2_relaxation_and_decoherence", - "3_measurement_error_mitigation", - "4_randomized_benchmarking", - "5_quantum_volume", - "6_repetition_code", - "7_accreditation", - "8_tomography", - "9_entanglement_verification", - "index", -] - - -def _redirects_for_tutorials() -> Dict[str, str]: - result = {} - for tutorial in _optimization_tutorials: - result[ - "tutorials/optimization/%s" % tutorial - ] = "https://qiskit.org/documentation/optimization/tutorials/index.html" - for tutorial in _finance_tutorials: - result[ - "tutorials/finance/%s" % tutorial - ] = "https://qiskit.org/documentation/finance/tutorials/index.html" - for tutorial in _chemistry_tutorials: - result[ - "tutorials/chemistry/%s" % tutorial - ] = "https://qiskit.org/documentation/nature/tutorials/index.html" - for tutorial in _ml_tutorials: - result[ - "tutorials/machine_learning/%s" % tutorial - ] = "https://qiskit.org/documentation/machine-learning/tutorials/index.html" - for tutorial in _dynamics_tutorials: - result[ - "tutorials/circuits_advanced/%s" % tutorial - ] = "https://qiskit.org/documentation/dynamics/tutorials/index.html" - for tutorial in _experiments_tutorials: - result[ - "tutorials/noise/%s" % tutorial - ] = "https://qiskit.org/documentation/experiments/tutorials/index.html" - return result - - -def _redirects_for_aer() -> Dict[str, str]: - """Set up URL redirects for Aer. - - We've gone through two migrations with Aer: - - 1) From `qiskit.org/documentation/stubs/qiskit.providers.aer` to - `qiskit.org/documentation/stubs/qiskit_aer`. - 2) From `qiskit.org/documentation/stubs/qiskit_aer` to - `qiskit.org/documentation/aer/stubs/qiskit_aer`. - """ - result = {} - original_sources = (Path(__file__).parent / "aer_sources.txt").read_text() - for original_provider_html_file_path in original_sources.splitlines(): - qiskit_aer_html_file_path = original_provider_html_file_path.replace( - "qiskit.providers.aer", "qiskit_aer" - ) - new_url = ( - "https://qiskit.org/documentation/aer" - if ".extensions." in original_provider_html_file_path - else f"https://qiskit.org/documentation/aer/{qiskit_aer_html_file_path}" - ) - result.update( - { - original_provider_html_file_path: new_url, - qiskit_aer_html_file_path: new_url, - } - ) - return result diff --git a/requirements-dev.txt b/requirements-dev.txt index 050d6e1da73f..91b750c4e1ec 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -14,7 +14,6 @@ seaborn>=0.9.0 nbsphinx cvxpy networkx>=2.3 -sphinx-reredirects qiskit-qasm3-import; python_version>'3.7' # Dev tooling diff --git a/test/test_url_redirects.py b/test/test_url_redirects.py deleted file mode 100644 index a63754ba9cbe..000000000000 --- a/test/test_url_redirects.py +++ /dev/null @@ -1,54 +0,0 @@ -"""Test url_redirects.py.""" - -from pathlib import Path -from unittest import TestCase - -from docs.url_redirects import _redirects_for_aer - - -class CustomExtensionsTest(TestCase): - """Test url_redirects.py.""" - - def test_redirects_for_aer(self) -> None: - """Test _redirects_for_aer().""" - - result = _redirects_for_aer() - num_lines_aer_sources = len( - Path("docs/aer_sources.txt").read_text(encoding="utf-8").splitlines() - ) - self.assertEqual(len(result), num_lines_aer_sources * 2) - - # Spot check some redirects. - self.assertEqual( - result["stubs/qiskit.providers.aer.AerError.html"], - "https://qiskit.org/documentation/aer/stubs/qiskit_aer.AerError.html", - ) - self.assertEqual( - result["stubs/qiskit_aer.AerError.html"], - "https://qiskit.org/documentation/aer/stubs/qiskit_aer.AerError.html", - ) - self.assertEqual( - result["stubs/qiskit.providers.aer.library.SaveAmplitudes.is_parameterized.html"], - ( - "https://qiskit.org/documentation/aer/" - "stubs/qiskit_aer.library.SaveAmplitudes.is_parameterized.html" - ), - ) - self.assertEqual( - result["stubs/qiskit_aer.library.SaveAmplitudes.is_parameterized.html"], - ( - "https://qiskit.org/documentation/aer/stubs/" - "qiskit_aer.library.SaveAmplitudes.is_parameterized.html" - ), - ) - - # Extensions should redirect to the general Aer docs, - # since the API was removed. - self.assertEqual( - result["stubs/qiskit.providers.aer.extensions.Snapshot.html"], - "https://qiskit.org/documentation/aer", - ) - self.assertEqual( - result["stubs/qiskit.providers.aer.extensions.Snapshot.html"], - "https://qiskit.org/documentation/aer", - ) diff --git a/tox.ini b/tox.ini index 85d97d944411..81c03390c04d 100644 --- a/tox.ini +++ b/tox.ini @@ -56,7 +56,7 @@ deps = # It does not hurt to also install the package in the `deps` stage. .[all] commands = - sphinx-build -b html {posargs} -d {toxinidir}/docs/.doctrees {toxinidir}/docs/ {toxinidir}/docs/_build/html + sphinx-build -j auto -b html {posargs} -d {toxinidir}/docs/.doctrees {toxinidir}/docs/ {toxinidir}/docs/_build/html [testenv:docs-clean] skip_install = true