Zum Hauptinhalt springen
Noch nicht übersetzt

Diese Seite wurde noch nicht übersetzt. Sie sehen die englische Originalversion.

Automatic Code Modifications

doQumentation automatically applies a small number of modifications to upstream Qiskit tutorial and guide content to ensure a smooth, interactive experience. This page documents every modification so you can understand exactly what changed compared to the original IBM Quantum documentation.

Notebook copies (Open in Colab / Binder / Code Engine)​

When you click Open in Colab, Open in JupyterLab, or Open in Code Engine, you receive a copy of the original notebook with these additions:

1. Setup notice cell (markdown)​

A blockquote cell is inserted at the very top explaining that doQumentation added an automatic setup cell. It links back to this page.

2. Prerequisites cell (code)​

A code cell is inserted after the notice that:

  • Installs required packages (qiskit, qiskit-aer, qiskit-ibm-runtime, pylatexenc, plus any tutorial-specific packages detected via import scanning). The install is skipped if packages are already present (e.g. on Binder or Code Engine where they are pre-installed).
  • Provides a commented-out credentials template for IBM Quantum, so users who want to run on real hardware can uncomment and fill in their API key.

On Google Colab, this cell auto-runs on notebook open via the cell_execution_strategy: setup metadata flag.

3. Image path rewrites​

Relative image paths (/docs/images/..., /learning/images/...) are rewritten to work correctly in standalone notebook environments.

MDX pages (in-browser rendering)​

The tutorials displayed on this website are converted from upstream .ipynb notebooks or .mdx files. The following transforms are applied:

  • pip install lines are added to Python code blocks that import third-party packages, enabling one-click execution via thebelab.
  • IBM Tutorial Survey section: A note is appended clarifying the survey belongs to IBM Quantum and linking to doQumentation's GitHub Issues for site-specific feedback.
  • Feedback widget: A "Was this helpful?" widget is appended at the bottom of each tutorial, tracked via privacy-friendly Umami analytics.
  • MDX syntax fixes: Curly braces, heading hierarchy, and JSX compatibility issues are automatically corrected for Docusaurus rendering.
  • OpenInLabBanner: An interactive banner is injected below the title with buttons to open the notebook in Colab, Binder, or Code Engine.

What is NOT modified​

  • The tutorial content itself (explanations, code logic, outputs) is never altered.
  • Original author attribution is preserved via frontmatter and the NOTICE file (Apache 2.0 / CC BY-SA 4.0 licenses).
  • No telemetry or tracking code is injected into notebooks. Analytics (Umami) only runs on the doQumentation website, not in exported notebooks.

Source code​

All transformations are implemented in scripts/sync-content.py.