Skip to content

Add missing API Refs to docs (Cherry-pick of #1343)#1350

Merged
kt474 merged 1 commit intoQiskit:stable/0.18from
Eric-Arellano:cp-missing-api
Jan 29, 2024
Merged

Add missing API Refs to docs (Cherry-pick of #1343)#1350
kt474 merged 1 commit intoQiskit:stable/0.18from
Eric-Arellano:cp-missing-api

Conversation

@Eric-Arellano
Copy link
Copy Markdown
Collaborator

Summary

The documentation from the transpile and fake_provider modules does not appear in the rendered docs in qiskit.org/documentation or docs.quantum-computing.ibm.com.

Details and comments

Fixes Qiskit Docs Issue #238

Replaces PR #1330.

Transpiler Doc files added:

  • qiskit_ibm_runtime.transpiler.passes.html
  • qiskit_ibm_provider.transpiler.passes.basis.html
  • qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.html
  • qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.html
  • qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.html
  • qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.html
  • qiskit_ibm_provider.transpiler.passes.scheduling.html
  • qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.html
  • qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.html
Fake Provider Docs added:
  • qiskit_ibm_runtime.fake_provider.FakeAlmaden.html
  • qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.html
  • qiskit_ibm_runtime.fake_provider.FakeArmonk.html
  • qiskit_ibm_runtime.fake_provider.FakeArmonkV2.html
  • qiskit_ibm_runtime.fake_provider.FakeAthens.html
  • qiskit_ibm_runtime.fake_provider.FakeAthensV2.html
  • qiskit_ibm_runtime.fake_provider.FakeAuckland.html
  • qiskit_ibm_runtime.fake_provider.FakeBelem.html
  • qiskit_ibm_runtime.fake_provider.FakeBelemV2.html
  • qiskit_ibm_runtime.fake_provider.FakeBoeblingen.html
  • qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.html
  • qiskit_ibm_runtime.fake_provider.FakeBogota.html
  • qiskit_ibm_runtime.fake_provider.FakeBogotaV2.html
  • qiskit_ibm_runtime.fake_provider.FakeBrooklyn.html
  • qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.html
  • qiskit_ibm_runtime.fake_provider.FakeBurlington.html
  • qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.html
  • qiskit_ibm_runtime.fake_provider.FakeCairo.html
  • qiskit_ibm_runtime.fake_provider.FakeCairoV2.html
  • qiskit_ibm_runtime.fake_provider.FakeCambridge.html
  • qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.html
  • qiskit_ibm_runtime.fake_provider.FakeCasablanca.html
  • qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.html
  • qiskit_ibm_runtime.fake_provider.FakeEssex.html
  • qiskit_ibm_runtime.fake_provider.FakeEssexV2.html
  • qiskit_ibm_runtime.fake_provider.FakeGeneva.html
  • qiskit_ibm_runtime.fake_provider.FakeGuadalupe.html
  • qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.html
  • qiskit_ibm_runtime.fake_provider.FakeHanoi.html
  • qiskit_ibm_runtime.fake_provider.FakeHanoiV2.html
  • qiskit_ibm_runtime.fake_provider.FakeJakarta.html
  • qiskit_ibm_runtime.fake_provider.FakeJakartaV2.html
  • qiskit_ibm_runtime.fake_provider.FakeJohannesburg.html
  • qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.html
  • qiskit_ibm_runtime.fake_provider.FakeKolkata.html
  • qiskit_ibm_runtime.fake_provider.FakeKolkataV2.html
  • qiskit_ibm_runtime.fake_provider.FakeLagos.html
  • qiskit_ibm_runtime.fake_provider.FakeLagosV2.html
  • qiskit_ibm_runtime.fake_provider.FakeLima.html
  • qiskit_ibm_runtime.fake_provider.FakeLimaV2.html
  • qiskit_ibm_runtime.fake_provider.FakeLondon.html
  • qiskit_ibm_runtime.fake_provider.FakeLondonV2.html
  • qiskit_ibm_runtime.fake_provider.FakeManhattan.html
  • qiskit_ibm_runtime.fake_provider.FakeManhattanV2.html
  • qiskit_ibm_runtime.fake_provider.FakeManila.html
  • qiskit_ibm_runtime.fake_provider.FakeManilaV2.html
  • qiskit_ibm_runtime.fake_provider.FakeMelbourne.html
  • qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.html
  • qiskit_ibm_runtime.fake_provider.FakeMontreal.html
  • qiskit_ibm_runtime.fake_provider.FakeMontrealV2.html
  • qiskit_ibm_runtime.fake_provider.FakeMumbai.html
  • qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.html
  • qiskit_ibm_runtime.fake_provider.FakeNairobi.html
  • qiskit_ibm_runtime.fake_provider.FakeNairobiV2.html
  • qiskit_ibm_runtime.fake_provider.FakeOslo.html
  • qiskit_ibm_runtime.fake_provider.FakeOurense.html
  • qiskit_ibm_runtime.fake_provider.FakeOurenseV2.html
  • qiskit_ibm_runtime.fake_provider.FakeParis.html
  • qiskit_ibm_runtime.fake_provider.FakeParisV2.html
  • qiskit_ibm_runtime.fake_provider.FakePerth.html
  • qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.html
  • qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.html
  • qiskit_ibm_runtime.fake_provider.FakePrague.html
  • qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.html
  • qiskit_ibm_runtime.fake_provider.FakeProvider.html
  • qiskit_ibm_runtime.fake_provider.FakeQuito.html
  • qiskit_ibm_runtime.fake_provider.FakeQuitoV2.html
  • qiskit_ibm_runtime.fake_provider.FakeRochester.html
  • qiskit_ibm_runtime.fake_provider.FakeRochesterV2.html
  • qiskit_ibm_runtime.fake_provider.FakeRome.html
  • qiskit_ibm_runtime.fake_provider.FakeRomeV2.html
  • qiskit_ibm_runtime.fake_provider.FakeRueschlikon.html
  • qiskit_ibm_runtime.fake_provider.FakeSantiago.html
  • qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.html
  • qiskit_ibm_runtime.fake_provider.FakeSherbrooke.html
  • qiskit_ibm_runtime.fake_provider.FakeSingapore.html
  • qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.html
  • qiskit_ibm_runtime.fake_provider.FakeSydney.html
  • qiskit_ibm_runtime.fake_provider.FakeSydneyV2.html
  • qiskit_ibm_runtime.fake_provider.FakeTenerife.html
  • qiskit_ibm_runtime.fake_provider.FakeTokyo.html
  • qiskit_ibm_runtime.fake_provider.FakeToronto.html
  • qiskit_ibm_runtime.fake_provider.FakeTorontoV2.html
  • qiskit_ibm_runtime.fake_provider.FakeValencia.html
  • qiskit_ibm_runtime.fake_provider.FakeValenciaV2.html
  • qiskit_ibm_runtime.fake_provider.FakeVigo.html
  • qiskit_ibm_runtime.fake_provider.FakeVigoV2.html
  • qiskit_ibm_runtime.fake_provider.FakeWashington.html
  • qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.html
  • qiskit_ibm_runtime.fake_provider.FakeYorktown.html
  • qiskit_ibm_runtime.fake_provider.FakeYorktownV2.html

### Summary
The documentation from the `transpile` and `fake_provider` modules does not appear in the rendered docs in qiskit.org/documentation or docs.quantum-computing.ibm.com.


### Details and comments

Fixes [Qiskit Docs Issue Qiskit#238](Qiskit/documentation#238)

Replaces PR Qiskit#1330.

Transpiler Doc files added:

 - qiskit_ibm_runtime.transpiler.passes.html
- qiskit_ibm_provider.transpiler.passes.basis.html
- qiskit_ibm_provider.transpiler.passes.scheduling.ALAPScheduleAnalysis.html
- qiskit_ibm_provider.transpiler.passes.scheduling.ASAPScheduleAnalysis.html
- qiskit_ibm_provider.transpiler.passes.scheduling.BlockBasePadder.html
- qiskit_ibm_provider.transpiler.passes.scheduling.DynamicCircuitInstructionDurations.html
- qiskit_ibm_provider.transpiler.passes.scheduling.html
- qiskit_ibm_provider.transpiler.passes.scheduling.PadDelay.html
- qiskit_ibm_provider.transpiler.passes.scheduling.PadDynamicalDecoupling.html

<details>
<summary> Fake Provider Docs added: </summary>

- qiskit_ibm_runtime.fake_provider.FakeAlmaden.html
- qiskit_ibm_runtime.fake_provider.FakeAlmadenV2.html
- qiskit_ibm_runtime.fake_provider.FakeArmonk.html
- qiskit_ibm_runtime.fake_provider.FakeArmonkV2.html
- qiskit_ibm_runtime.fake_provider.FakeAthens.html
- qiskit_ibm_runtime.fake_provider.FakeAthensV2.html
- qiskit_ibm_runtime.fake_provider.FakeAuckland.html
- qiskit_ibm_runtime.fake_provider.FakeBelem.html
- qiskit_ibm_runtime.fake_provider.FakeBelemV2.html
- qiskit_ibm_runtime.fake_provider.FakeBoeblingen.html
- qiskit_ibm_runtime.fake_provider.FakeBoeblingenV2.html
- qiskit_ibm_runtime.fake_provider.FakeBogota.html
- qiskit_ibm_runtime.fake_provider.FakeBogotaV2.html
- qiskit_ibm_runtime.fake_provider.FakeBrooklyn.html
- qiskit_ibm_runtime.fake_provider.FakeBrooklynV2.html
- qiskit_ibm_runtime.fake_provider.FakeBurlington.html
- qiskit_ibm_runtime.fake_provider.FakeBurlingtonV2.html
- qiskit_ibm_runtime.fake_provider.FakeCairo.html
- qiskit_ibm_runtime.fake_provider.FakeCairoV2.html
- qiskit_ibm_runtime.fake_provider.FakeCambridge.html
- qiskit_ibm_runtime.fake_provider.FakeCambridgeV2.html
- qiskit_ibm_runtime.fake_provider.FakeCasablanca.html
- qiskit_ibm_runtime.fake_provider.FakeCasablancaV2.html
- qiskit_ibm_runtime.fake_provider.FakeEssex.html
- qiskit_ibm_runtime.fake_provider.FakeEssexV2.html
- qiskit_ibm_runtime.fake_provider.FakeGeneva.html
- qiskit_ibm_runtime.fake_provider.FakeGuadalupe.html
- qiskit_ibm_runtime.fake_provider.FakeGuadalupeV2.html
- qiskit_ibm_runtime.fake_provider.FakeHanoi.html
- qiskit_ibm_runtime.fake_provider.FakeHanoiV2.html
- qiskit_ibm_runtime.fake_provider.FakeJakarta.html
- qiskit_ibm_runtime.fake_provider.FakeJakartaV2.html
- qiskit_ibm_runtime.fake_provider.FakeJohannesburg.html
- qiskit_ibm_runtime.fake_provider.FakeJohannesburgV2.html
- qiskit_ibm_runtime.fake_provider.FakeKolkata.html
- qiskit_ibm_runtime.fake_provider.FakeKolkataV2.html
- qiskit_ibm_runtime.fake_provider.FakeLagos.html
- qiskit_ibm_runtime.fake_provider.FakeLagosV2.html
- qiskit_ibm_runtime.fake_provider.FakeLima.html
- qiskit_ibm_runtime.fake_provider.FakeLimaV2.html
- qiskit_ibm_runtime.fake_provider.FakeLondon.html
- qiskit_ibm_runtime.fake_provider.FakeLondonV2.html
- qiskit_ibm_runtime.fake_provider.FakeManhattan.html
- qiskit_ibm_runtime.fake_provider.FakeManhattanV2.html
- qiskit_ibm_runtime.fake_provider.FakeManila.html
- qiskit_ibm_runtime.fake_provider.FakeManilaV2.html
- qiskit_ibm_runtime.fake_provider.FakeMelbourne.html
- qiskit_ibm_runtime.fake_provider.FakeMelbourneV2.html
- qiskit_ibm_runtime.fake_provider.FakeMontreal.html
- qiskit_ibm_runtime.fake_provider.FakeMontrealV2.html
- qiskit_ibm_runtime.fake_provider.FakeMumbai.html
- qiskit_ibm_runtime.fake_provider.FakeMumbaiV2.html
- qiskit_ibm_runtime.fake_provider.FakeNairobi.html
- qiskit_ibm_runtime.fake_provider.FakeNairobiV2.html
- qiskit_ibm_runtime.fake_provider.FakeOslo.html
- qiskit_ibm_runtime.fake_provider.FakeOurense.html
- qiskit_ibm_runtime.fake_provider.FakeOurenseV2.html
- qiskit_ibm_runtime.fake_provider.FakeParis.html
- qiskit_ibm_runtime.fake_provider.FakeParisV2.html
- qiskit_ibm_runtime.fake_provider.FakePerth.html
- qiskit_ibm_runtime.fake_provider.FakePoughkeepsie.html
- qiskit_ibm_runtime.fake_provider.FakePoughkeepsieV2.html
- qiskit_ibm_runtime.fake_provider.FakePrague.html
- qiskit_ibm_runtime.fake_provider.FakeProviderForBackendV2.html
- qiskit_ibm_runtime.fake_provider.FakeProvider.html
- qiskit_ibm_runtime.fake_provider.FakeQuito.html
- qiskit_ibm_runtime.fake_provider.FakeQuitoV2.html
- qiskit_ibm_runtime.fake_provider.FakeRochester.html
- qiskit_ibm_runtime.fake_provider.FakeRochesterV2.html
- qiskit_ibm_runtime.fake_provider.FakeRome.html
- qiskit_ibm_runtime.fake_provider.FakeRomeV2.html
- qiskit_ibm_runtime.fake_provider.FakeRueschlikon.html
- qiskit_ibm_runtime.fake_provider.FakeSantiago.html
- qiskit_ibm_runtime.fake_provider.FakeSantiagoV2.html
- qiskit_ibm_runtime.fake_provider.FakeSherbrooke.html
- qiskit_ibm_runtime.fake_provider.FakeSingapore.html
- qiskit_ibm_runtime.fake_provider.FakeSingaporeV2.html
- qiskit_ibm_runtime.fake_provider.FakeSydney.html
- qiskit_ibm_runtime.fake_provider.FakeSydneyV2.html
- qiskit_ibm_runtime.fake_provider.FakeTenerife.html
- qiskit_ibm_runtime.fake_provider.FakeTokyo.html
- qiskit_ibm_runtime.fake_provider.FakeToronto.html
- qiskit_ibm_runtime.fake_provider.FakeTorontoV2.html
- qiskit_ibm_runtime.fake_provider.FakeValencia.html
- qiskit_ibm_runtime.fake_provider.FakeValenciaV2.html
- qiskit_ibm_runtime.fake_provider.FakeVigo.html
- qiskit_ibm_runtime.fake_provider.FakeVigoV2.html
- qiskit_ibm_runtime.fake_provider.FakeWashington.html
- qiskit_ibm_runtime.fake_provider.FakeWashingtonV2.html
- qiskit_ibm_runtime.fake_provider.FakeYorktown.html
- qiskit_ibm_runtime.fake_provider.FakeYorktownV2.html

</details>

Co-authored-by: Rebecca Dimock <66339736+beckykd@users.noreply.github.com>
@coveralls
Copy link
Copy Markdown

Pull Request Test Coverage Report for Build 7702879653

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 59.262%

Totals Coverage Status
Change from base Build 7688432579: 0.0%
Covered Lines: 3196
Relevant Lines: 5393

💛 - Coveralls

@kt474 kt474 merged commit 9997652 into Qiskit:stable/0.18 Jan 29, 2024
@Eric-Arellano Eric-Arellano deleted the cp-missing-api branch January 30, 2024 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants