Qiskit API: group modules into logical sections #1211
Description
For example
The main changes:
- group related modules into new categories
- flatten submodules to reduce overall nesting
Qiskit 1.0 modules
code to find modules
from pathlib import Path
import json
raw = Path("docs/api/qiskit/_toc.json").read_text()
content = json.loads(raw)
all_modules = set()
def add_modules(entry) -> None:
if entry.get("title").startswith("qiskit."):
all_modules.add(entry["title"])
if "children" in entry:
for child in entry["children"]:
add_modules(child)
add_modules(content)
print("\n".join(sorted(all_modules)))module list
qiskit.assembler
qiskit.circuit
qiskit.circuit.classical
qiskit.circuit.classicalfunction
qiskit.circuit.library
qiskit.circuit.singleton
qiskit.compiler
qiskit.converters
qiskit.dagcircuit
qiskit.exceptions
qiskit.passmanager
qiskit.primitives
qiskit.providers
qiskit.providers.basic_provider
qiskit.providers.fake_provider
qiskit.providers.models
qiskit.pulse
qiskit.qasm2
qiskit.qasm3
qiskit.qobj
qiskit.qpy
qiskit.quantum_info
qiskit.result
qiskit.scheduler
qiskit.synthesis
qiskit.synthesis.unitary.aqc
qiskit.transpiler
qiskit.transpiler.passes
qiskit.transpiler.passes.synthesis.plugin
qiskit.transpiler.preset_passmanagers
qiskit.transpiler.preset_passmanagers.plugin
qiskit.utils
qiskit.visualization