API Reference Examples

This page highlights good examples of API reference within Qiskit projects. You can follow these examples to create your own API reference.

Module API

This section highlights good examples of model level API pages. These are good examples because they provide an overview of the module, contain commonly used code examples, highlight important information to take note as well as group classes in the module in a meaningful way.

• qiskit.circuit

• qiskit.visualization

• qiskit.providers.fake_provider

Code Examples

This section highlights good examples for adding code examples in API reference.

• qiskit.visualization.plot_histogram()

• qiskit.visualization.plot_bloch_vector()

• qiskit.visualization.plot_bloch_multivector()

• qiskit.visualization.plot_state_city()

• qiskit.visualization.plot_state_hinton()

• qiskit.visualization.plot_state_paulivec()

• qiskit.visualization.plot_state_qsphere()