ユーザーガイド

インストール

pip install atsphinx-qrcode

使用方法

セットアップ

conf.py

extensions = [
    "atsphinx.qrcode",
]

ドキュメントへの記述

.. qrcode::

    https://example.com

ディレクティブ

.. qrcode::

このディレクティブはコンテンツ部分から生成した"QRコード"を挿入します。画像はData URIスキーマを用いたSVGフォーマットであり、 html （派生含む）ビルダーによって``img`` 要素ととして出力されます。

ディレクティブは image ディレクティブを継承しています。image ディレクティブと同じオプションを使えますが、 ``alt``だけは強制的にコンテンツに置き換わります。

ディレクティブには追加のオプションがあります。

:qr_version:

QRコードの型番でシンボルのサイズとして使われます。1から40の間で指定してください。

:qr_error_correction:

破損しても復元するための"誤り訂正"に関するレベルです。"L", "M", "Q", "H"のいずれかを指定してください（レベルの低い順に並んでいます）。

記述例

.. qrcode::

    https://example.com

.. qrcode::
    :qr_version: 10

    https://example.com

.. qrcode::
    :qr_error_correction: H

    https://example.com

.. qrcode::
    :qr_version: 10
    :qr_error_correction: H

    https://example.com