自動コード修正

doQumentationは、スムーズでインタラクティブな体験を提供するため、アップストリームの Qiskitチュートリアルおよびガイドのコンテンツに少数の修正を自動的に適用します。 このページでは、元のIBM Quantumドキュメントと比較して何が変更されたかを正確に把握できるよう、 すべての修正を記載しています。

ノートブックのコピー（Colab / Binder / Code Engineで開く）

Colabで開く、JupyterLabで開く、またはCode Engineで開くをクリックすると、 以下の追加が加えられた元のノートブックのコピーを受け取ります。

1. セットアップ通知セル（Markdown）

doQumentationが自動セットアップ・セルを追加したことを説明するブロッククォート・セルが 最上部に挿入されます。このセルはこのページにリンクしています。

2. 前提条件セル（コード）

通知の後に挿入されるコード・セルは以下を行います：

• 必要なパッケージのインストール（qiskit、qiskit-aer、qiskit-ibm-runtime、 pylatexenc、およびインポートのスキャンによって検出されたチュートリアル固有のパッケージ）。 パッケージがすでに存在する場合（例：BinderやCode Engineでプリインストールされている場合）、 インストールはスキップされます。
• IBM Quantumのコメントアウトされた認証情報テンプレートの提供。実際のハードウェアで 実行したいユーザーがAPIキーをコメント解除して入力できるようにします。

Google Colabでは、このセルはcell_execution_strategy: setupメタデータ・フラグにより ノートブックを開いたときに自動実行されます。

3. 画像パスの書き換え

相対画像パス（/docs/images/...、/learning/images/...）は、スタンドアロンの ノートブック環境で正しく動作するよう書き換えられます。

MDXページ（ブラウザ内レンダリング）

このウェブサイトに表示されるチュートリアルは、アップストリームの.ipynbノートブックまたは .mdxファイルから変換されます。以下の変換が適用されます：

• pip installの行：サードパーティ・パッケージをインポートするPythonコード・ブロックに追加され、 thebelabによるワンクリック実行が可能になります。
• IBMチュートリアル・アンケートのセクション：アンケートがIBM Quantumに属することを 明確にする注記が追加され、サイト固有のフィードバックについてはdoQumentationのGitHub Issuesへのリンクが提供されます。
• フィードバック・ウィジェット：各チュートリアルの下部に「役に立ちましたか？」 ウィジェットが追加され、プライバシーに配慮したUmamiアナリティクスで追跡されます。
• MDX構文の修正：波括弧、見出し階層、JSX互換性の問題がDocusaurusレンダリング向けに 自動的に修正されます。
• OpenInLabBanner：タイトルの下にインタラクティブ・バナーが挿入され、ノートブックを Colab、Binder、またはCode Engineで開くためのボタンが表示されます。

修正されないもの

• チュートリアルのコンテンツ自体（説明、コードロジック、出力）は変更されません。
• 元の著者のクレジットはフロントマターとNOTICEファイルを通じて保持されます （Apache 2.0 / CC BY-SA 4.0ライセンス）。
• テレメトリやトラッキング・コードはノートブックに挿入されません。アナリティクス （Umami）はdoQumentationウェブサイト上でのみ動作し、エクスポートされたノートブックでは動作しません。

ソースコード

すべての変換は scripts/sync-content.py に実装されています。