bokeh.sphinxext

Bokeh文書の生成の自動化と簡略化を支援するために，いくつかのSphinx拡張が作成されている.これらの問題の多くは一般的な関心を集めません bokeh.sphinxext.bokeh_plot これは，誰でも自分のSphinx文書にbokehグラフを直接含めて埋め込むことを可能にする.

bokeh_autodoc

Bokeh拡張をSphinx autocに統合する.

自動ドッキング指示を確保する(例えば autoclass Bokehに特定された命令は適切なときに自動的に使用される.以下のBokeh拡張を構成しました。

bokeh_color

文書Bokeh命名色。

♪the bokeh-color コマンドはそのパラメータとして名前色を受け取る：

.. bokeh-color:: aliceblue

出力としてマーカ色サンプルを生成する.

aliceblue

♪the bokeh-color 方向は明示的に使用することもできますが bokeh_autodoc 延期する。

bokeh_enum

Bokehを徹底的に記録して列挙する

♪the bokeh-enum 命令は、すべての許容値を含む有用な文書を生成することである。値の数が大きい場合、完全なリストは折り畳み可能なコードブロックに配置される。

この命令はBokeh枚挙変数の名前をパラメータとし，モジュール名をオプションとする.オプションの説明は、コンテンツとして追加されてもよい：

.. bokeh-enum:: baz
    :module: bokeh.sphinxext.sample

    Specify a baz style

サンプル

上の命令は以下の出力を生成する：

baz = Enumeration(a, b, c)

BAZスタイルの指定

それでも bokeh-enum 明示的に使用することができ、より多くの場合 bokeh_autodoc 延期する。つまり、上の出力は以下のコードから直接生成される。

#: Specify a baz style
baz = enumeration("a", "b", "c")

bokeh_github

Bokeh Github資源へのリンクに簡略化する.

本モジュールは、Bokeh Githubリポジトリ内の様々なリソースに容易にリンクするために使用できる4つの新しい役割を紹介します。

:bokeh-commit: ：特定の提出にリンクする

:bokeh-issue: ：問題へのリンク

:bokeh-pull: ：引取要求へのリンク

:bokeh-tree: ：(バージョン化)ソース木URLへのリンク

サンプル

以下のコード：

The repo history shows that :bokeh-commit:`bf19bcb` was made in
in :bokeh-pull:`1698`, which closed :bokeh-issue:`1694`. This included
updating all of the files in the :bokeh-tree:`examples` subdirectory.

生成出力：

買い戻しの歴史によると commit bf19bcb 中国で作られたのです pull request 1698 閉鎖されています #1694 それがそうです。これには更新が含まれています examples サブカタログです。

bokeh_jinja

Bokeh JJIA 2テンプレートを自動記録する.

このコマンドは、JJANA 2テンプレートを定義する属性名にモジュールパスをロードします。

.. bokeh-jinja:: bokeh.core.templates.FILE

すべてのテンプレートパラメータが表示され、テンプレートソースコードは折り畳み可能なコードブロックに表示されます。例えば、上記の用法は、以下の出力を生成する。

FILE = <Template 'file.html'>

Bokehモデルを基本.htmlファイルにレンダリングします。

パラメータ

  • title (str) -- のの価値 <title> ラベル

  • plot_resources (str) -- 通常、資源の出力は

  • plot_script (str) -- 一般に、PLOT_SCRIPTの出力

ユーザは，これらの同じパラメータを受け取る自分のJJIA 2テンプレートを提供することで定義ファイルから出力することができる.

Template: file.html 
{% from macros import embed %}

<!DOCTYPE html>
<html lang="en">
  {% block head %}
  <head>
    {% block inner_head %}
      <meta charset="utf-8">
      <title>{% block title %}{{ title | e if title else "Bokeh Plot" }}{% endblock %}</title>
      {% block preamble %}{% endblock %}
      {% block resources %}
        {% block css_resources %}
          {{ bokeh_css | indent(8) if bokeh_css }}
        {% endblock %}
        {% block js_resources %}
          {{ bokeh_js | indent(8) if bokeh_js }}
        {% endblock %}
      {% endblock %}
      {% block postamble %}{% endblock %}
    {% endblock %}
  </head>
  {% endblock %}
  {% block body %}
  <body>
    {% block inner_body %}
      {% block contents %}
        {% for doc in docs %}
          {{ embed(doc) if doc.elementid }}
          {% for root in doc.roots %}
            {% block root scoped %}
              {{ embed(root) | indent(10) }}
            {% endblock %}
          {% endfor %}
        {% endfor %}
      {% endblock %}
      {{ plot_script | indent(8) }}
    {% endblock %}
  </body>
  {% endblock %}
</html>

bokeh_model

Bokehモデル類を徹底的に記録した。

♪the bokeh-model 命令はBokeh Modelサブクラスのすべての属性(Bokeh属性を含む)を自動的に記録する.すべての可能なJSONフィールドを示すJSONプロトタイプも生成される。

この命令は，Bokehモデルクラスの名前をパラメータとし，そのモジュールをオプションとする：

.. bokeh-model:: Foo
    :module: bokeh.sphinxext.sample

サンプル

以下の定義については、参照されたい bokeh.sphinxext.sample.Foo ：

class Foo(Model):
    """ This is a Foo model. """
    index = Either(Auto, Enum('abc', 'def', 'xzy'), help="doc for index")
    value = Tuple(Float, Float, help="doc for value")

上の用法は以下の出力を生成する：

class Foo(*args, **kwargs)[ソース]

ベースクラス: bokeh.model.Model

これはFOOモデルです

index

property type: Either ( Auto , Enum ( Enumeration(abc, def, xzy) ) )

索引伝票

js_event_callbacks

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

イベント名のリストへのマッピング CustomJS 返電します。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_event 方法：

callback = CustomJS(code="console.log('tap event occurred')")
plot.js_on_event('tap', callback)
js_property_callbacks

property type: Dict ( String , List ( Instance ( CustomJS ) ) )

属性名のリストへのマッピング CustomJS コールバックは、文書作成時にBoehJS端に設定されます。

通常，この属性を直接修正すべきではなく，使用すべきである Model.js_on_change 方法：

callback = CustomJS(code="console.log('stuff')")
plot.x_range.js_on_change('start', callback)
name

属性タイプ： String

このモデルのユーザが提供する任意の名前.

文書を検索して特定のBokehモデルを検索する際には，この名前が有用である可能性がある.

>>> plot.circle([1,2,3], [4,5,6], name="temp")
>>> plot.select(name="temp")
[GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]

注釈

提供された任意の名前に対して一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもその名前を直接使用することはない。

subscribed_events

属性タイプ： List () String ）

Pythonは購読しているイベントリストをコールバックします。このモデルに対して、これはBokehJSからPythonに返されるイベントのセットです。

tags

属性タイプ： List () Any ）

このモデルに付加されるユーザが提供する任意の値のオプションリスト。

特定のBokehモデルを検索するために文書を検索する際に、このデータは有用である可能性がある：

>>> r = plot.circle([1,2,3], [4,5,6])
>>> r.tags = ["foo", 10]
>>> plot.select(tags=['foo', 10])
[GlyphRenderer(id='1de4c3df-a83d-480a-899b-fb263d3d5dd9', ...)]

あるいは必要なメタデータをアクセス可能なモデルに付加する便利な方法でしかありません CustomJS ダイヤルして待つ.

注釈

提供されたいかなるラベルに対しても一意保証または他の条件を強制的に実行することはなく、Bokehもいかなる理由でもこれらのラベルを直接使用することはない。

value

property type: Tuple ( Float , Float )

価値伝票.

apply_theme(property_values)

アプリケーションのセットは、デフォルト値のテーマ値ではなく使用されるが、アプリケーションセット値はカバーされない。

入力された辞書はそのまま保持し，他の事例と共有してメモリを節約することができる(したがって呼び出し方和 HasProps インスタンスはそれを修正すべきである).

パラメータ

property_values (dict) -- デフォルト値の代わりにテーマ値を使用します

戻り値

なし

classmethod dataspecs()

全員の名前を集める DataSpec 属性です。

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値

名前または名前 DataSpec 特性

戻り値の型

set[str]

classmethod dataspecs_with_props()

辞書を集めて全員の名前をマッピングします DataSpec 属性は関連する属性に付加される.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値

名前と名前のマッピング DataSpec 特性

戻り値の型

dict[str, DataSpec]

equals(other)

モデルの構造は平等である.

パラメータ

other (HasProps) -- 比較するもう一つの例は

戻り値

属性が構造的に等しいならばTrue，そうでなければFalseとなる.

2つのBokehモデル属性をJavaScriptを用いてリンクする.

これは、CustomJSコールバックを追加して、1つのBokehモデル属性が値を変更するときに別のBokehモデル属性を更新するプロセスを簡略化することができる便利な方法である。

パラメータ

  • attr (str) -- このモデル上のBokeh属性の名前

  • other (Model) -- Self.attrにリンクされたBokehモデル

  • other_attr (str) -- 上の属性 other リンクがつながっている

  • attr_selector (Union[int, str]) -- 購読可能表中の項目をリンクするためのインデックス attr

バージョン1.1での追加

例外

ValueError --

サンプル

このコードには js_link ：

select.js_link('value', plot, 'sizing_mode')

以下と同等である.

from bokeh.models import CustomJS
select.js_on_change('value',
    CustomJS(args=dict(other=plot),
             code="other.sizing_mode = this.value"
    )
)

また，範囲スライダの左側をattr_selectorを用いて描画のx_rangeに付加する：

range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)

これは以下のようなものです

from bokeh.models import CustomJS
range_slider.js_on_change('value',
    CustomJS(args=dict(other=plot.x_range),
             code="other.start = this.value[0]"
    )
)
js_on_change(event, *callbacks)

付加する. CustomJS 任意のBoehJSモデルイベントのコールバック.

BokehJS側では，モデル属性の変更イベントの形式は "change:property_name" それがそうです。便宜上，このメソッドに渡されるイベント名もモデル上の属性の名前であれば， "change:" 自動：

# these two are equivalent
source.js_on_change('data', callback)
source.js_on_change('change:data', callback)

しかし，属性変更イベントに加えて，他のタイプのイベントに応答することも可能である.例えば、データがストリーミングされる限り ColumnDataSource 使用、使用 "stream" 源上の事件：

source.js_on_change('streaming', callback)
layout(side, plot)
classmethod lookup(name)

見つかる PropertyDescriptor クラス上のBokeh属性に対して，属性名を与える.

パラメータ

name (str) -- 検索する属性の名前

戻り値

名前の属性の記述子 name

戻り値の型

PropertyDescriptor

on_change(attr, *callbacks)

このオブジェクトには，以下の場合にトリガするコールバックを追加する. attr 変化する。

パラメータ

  • attr (str) -- このオブジェクトの属性名

  • *callbacks (callable) -- 登録するコールバック関数

戻り値

なし

例：

widget.on_change('value', callback1, callback2, ..., callback_n)
classmethod properties(with_bases=True)

このような上の属性名を収集する.

この方法は (オプション) クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

パラメータ

with_bases (bool, optional) -- 結果に親クラスで定義された属性が含まれているかどうか.(デフォルト値：TRUE)

戻り値

属性名

戻り値の型

set[str]

classmethod properties_containers()

このようなすべてのコンテナ属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値

容器属性名

戻り値の型

set[str]

classmethod properties_with_refs()

このクラスにも引用されているすべての属性の名前を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

戻り値

引用の属性を持つ名前

戻り値の型

set[str]

properties_with_values(include_defaults: bool = True) → Dict[str, Any]

属性名をその値にマッピングした辞書を収集する.

この方法は いつも クラス階層構造を遍歴し，任意の親クラスで定義された属性を含む.

直列化不可能な属性をスキップし、属性値は、一般に属性から読み出される値とはやや異なる可能性がある“直列化”フォーマットを採用し、この方法は、オブジェクトインスタンスを可逆的に再構成するために必要な情報を返すことを目的とする。

パラメータ

include_defaults (bool, optional) -- オブジェクト作成以来明示的に設定されていない属性が含まれているかどうか。(デフォルト値：TRUE)

戻り値

属性名からその値へのマッピング

戻り値の型

dict

query_properties_with_values(query, include_defaults=True)

クエリの属性値 HasProps 述語を持つインスタンス.

パラメータ

  • query (callable) -- 属性記述子を受け取ってTrueまたはFalseの呼び出し可能関数を返す

  • include_defaults (bool, optional) -- ユーザが明示的に設定していない属性(デフォルト値：true)が含まれているかどうか

戻り値

適合属性の属性名と値のマッピング

戻り値の型

dict

references()

すべてに戻る Models この対象は引用されている.

remove_on_change(attr, *callbacks)

この対象からコールバックを削除する

select(selector)

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。

パラメータ

selector (JSON-like) --

戻り値

配列番号. [模型]

select_one(selector)

このオブジェクトおよびそのすべての参照において、所与のセレクタに一致するオブジェクトがクエリされる。複数のオブジェクトが見つかれば，エラーを引き起こす.単一のマッチングオブジェクトを返し、何も見つからない場合は、NONEを返す：パラメータセレクタ：：タイプセレクタ：JSONに類似している

戻り値

模型

set_from_json(name, json, models=None, setter=None)

JSONからこのオブジェクトの属性値を設定する.

パラメータ

  • name -- (Str)：設定する属性の名前

  • json -- (json-value)：設定する属性の値

  • models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.

  • setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

set_select(selector, updates)

指定された属性/値を有する所与のセレクタに一致するオブジェクトが更新される。

パラメータ

  • selector (JSON-like) --

  • updates (dict) --

戻り値

なし

themed_values()

すべてのテーマが提供するカバーを得る。

結果は属性名から値までの辞書形式で返されるか，または None 主題がこのインスタンスの任意の値をカバーしていない場合。

戻り値

DICTやNONE

to_json(include_defaults)

この対象属性を返す辞書は，“JSONタイプ”(文字列，数字，ブール値，無，辞書，リスト)のみを含む.

他のオブジェクトへの参照は“refs”(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ

include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

to_json_string(include_defaults)

このオブジェクト属性をコードするJSON文字列を返す.

他のオブジェクトへの参照は参照(オブジェクトIDとタイプ情報のみ)に系列化されるため，逆直列化プログラムはそれらの他のオブジェクトの完全な属性を単独で持つ必要がある.

対応のない from_json_string() 逆直列化オブジェクトは、通常、文書コンテキストで行われるからである(文書は引用を解析できるので)。

ほとんどの場合、文書全体を直列化して逆直列化することが望ましい。

パラメータ

include_defaults (bool) -- デフォルト値から変更されていない属性が含まれているかどうか

trigger(attr, old, new, hint=None, setter=None)
unapply_theme()

すべてのトピック値を削除し、デフォルト値を復元します。

戻り値

なし

update(**kwargs)

与えられたキーワードパラメータに基づいてオブジェクトの属性を更新する.

戻り値

なし

サンプル

以下の内容は等価である.

from bokeh.models import Range1d

r = Range1d

# set properties individually:
r.start = 10
r.end = 20

# update properties together:
r.update(start=10, end=20)
update_from_json(json_attributes, models=None, setter=None)

JSON属性辞書から対象の属性を更新する.

パラメータ

  • json_attributes -- (json-dict)：更新する属性と値

  • models (dict or None, optional) -- モデルIDからモデルへのマッピング(デフォルト値：なし)更新する属性も参照する値を持つ場合には，このオプションが必要となる.

  • setter (ClientSession or ServerSession or None, optional) -- これはBokehアプリケーションの“ブーメラン”の更新を阻止するためのものです。Bokehサーバアプリケーションのコンテキストでは，入力された属性更新は，更新を実行するセッションを用いてアノテーションを行う.この値は、更新によってトリガされた任意の後続の変更通知によって伝播される。セッションは、イベント設定器自身と比較し、自身からの任意の更新を抑制することができる。

戻り値

なし

property document

♪the Document このモデルは添付されています None ）

property struct

このモデルのBokehプロトコル“構造”，すなわち以下の形式の辞書：

{
    'type' : << view model name >>
    'id'   : << unique model id >>
}

他にもあるかもしれません subtype フィールド(このモデルがサブタイプである場合)。

JSON Prototype 
{
  "id": "23838",
  "index": "auto",
  "js_event_callbacks": {},
  "js_property_callbacks": {},
  "name": null,
  "subscribed_events": [],
  "tags": [],
  "value": null
}

♪the bokeh-model 方向は明示的に使用することもできますが bokeh_autodoc 延期する。

bokeh_options

Bokehオプション類を徹底的に記録します。

♪the bokeh-options コマンドは自動的に“キーワードパラメータ”というタイトルの下にBokeh Optionsクラスのすべての属性を記録する.

この命令は，Bokeh Optionsサブクラスの名前をパラメータとし，そのモジュールをオプションとする：

.. bokeh-options:: Opts
    :module: bokeh.sphinxext.sample

サンプル

以下の定義については、参照されたい bokeh.sphinxext.sample.Opts ：

class Opts(Options):
    """ This is an Options class """

    host = String(default="localhost", help="a host to connect to")
    port = Int(default=5890, help="a port to connect to")

上の用法は以下の出力を生成する：

キーワードパラメータ：

宿主.宿主 (String )：接続するホスト(デフォルト値：“localhost”)

港.港 (Int )：接続するポート(デフォルト値：5890)

bokeh_palette

単一のパレットの連結視覚表現を生成する.

♪the :bokeh-palette: 役割は、以下のいずれかを提供することによって使用することができる。

  • 由来のパレット名 bokeh.palettes 例えば、： Spectral9

  • 中パレット関数 bokeh.palettes パラメータと一緒に呼び出して、例えば viridis(12)

  • 明確な色リスト： ['#000000', '#333333', '#666666', '#999999', '#cccccc', '#ffffff']

このコマンドの以下の用法は以下のとおりである.

* by name: :bokeh-palette:`Spectral9`

* by function: :bokeh-palette:`viridis(12)`

* by list: :bokeh-palette:`['#000000', '#333333', '#666666', '#999999', '#cccccc', '#ffffff']`

生成出力：

  • 名前別：

  • 機能別：

  • リストを押す：

調色板色板の高さは20画素である.20色より短いパレットでは，色板のデフォルト幅は20画素である.大きなパレットが与えられると，HTMLスパンの幅は徐々に小さくなり，最小で1画素となる.例えば，式を用いて完全なViridisパレットを表示する.

:bokeh-palette:`viridis(256)`

出力が生成されます：

bokeh_palette_group

Bokeh調色板グループでパレットの可視化表示を生成する.

The bokeh.palettes modules expose attributes such as mpl, brewer, and d3 that provide groups of palettes. The bokeh-palette-group directive accepts the name of one of these groups, and generates a visual matrix of colors for every palette in the group.

一例として、以下にこの指示の使い方を示す。

.. bokeh-palette-group:: mpl

生成出力：

Cividis
3
4
5
6
7
8
9
10
11

Inferno
3
4
5
6
7
8
9
10
11

Magma
3
4
5
6
7
8
9
10
11

Plasma
3
4
5
6
7
8
9
10
11

Viridis
3
4
5
6
7
8
9
10
11

注釈

この拡張はBootstrapとJQueryの両方が存在すると仮定する(Bokeh文書のトピックはこの場合).このトピックをBokeh文書以外に使用する場合は、必ず手動でこれらのリソースを含めてください。

bokeh_plot

Sphinx HTML文書にはBokeh描画が含まれている.

他の出力タイプについては，占位子テキスト [graph] 生成されます

♪the bokeh-plot 命令は、以下の2つの方法を提供することによって使用することができる。

ソースファイルの経路 コマンドとしてのパラメータ：

.. bokeh-plot:: path/to/plot.py

注釈

.pyスクリプトは自動的にスキャンされません！あるディレクトリを.pyスキャンプロセスに含めるために、sphinx conf.pyファイルに以下のコマンドを使用してください：bokeh_lot_pyfile_include_dirs= [“dir 1”，“dir 2”]

内部接続コード コマンドの内容として：

.. bokeh-plot::

    from bokeh.plotting import figure, output_file, show

    output_file("example.html")

    x = [1, 2, 3, 4, 5]
    y = [6, 7, 6, 4, 5]

    p = figure(title="example", plot_width=300, plot_height=300)
    p.line(x, y, line_width=2)
    p.circle(x, y, size=10, fill_color="white")

    show(p)

文書文字列で使用される場合、この命令は、Sphinx autodocと共に使用されてもよい。

♪the bokeh-plot コマンドは以下のオプションを受け取ります。

ソース位置(‘上’，‘下’，‘なし’))：

ソース符号ブロックの位置(ある場合)がフォーマットされる。

リネン(Bool)：

ソースとともに行番号を表示するかどうか。

サンプル

上の連結サンプルコードは、以下の出力を生成する。

from bokeh.plotting import figure, output_file, show

output_file("example.html")

x = [1, 2, 3, 4, 5]
y = [6, 7, 6, 4, 5]

p = figure(title="example", plot_width=300, plot_height=300)
p.line(x, y, line_width=2)
p.circle(x, y, size=10, fill_color="white")

show(p)

bokeh_prop

Bokeh属性を徹底的に記録する.

♪the bokeh-prop コマンドは，関連する属性タイプの交差リンクを含むBokehモデル属性の文書を生成する.また，各属性の任意のヘルプ文字列も表示される.

このコマンドの名前は (class.attr) Bokeh属性のパラメータをそのパラメータ，モジュールをオプションとする：

.. bokeh-prop:: Bar.thing
    :module: bokeh.sphinxext.sample

サンプル

以下の定義については、参照されたい bokeh.sphinxext.sample.Bar ：

class Bar(Model):
    """ This is a Bar model. """
    thing = List(Int, help="doc for thing")

上の用法は以下の出力を生成する：

thing

属性タイプ： List () Int ）

伝票を交換する

♪the bokeh-prop 方向は明示的に使用することもできますが bokeh_autodoc 延期する。

bokeh_releases

すべてのBokeh発行説明を1つのページに発行します。

この指令収集は docs/releases サブディレクトリに含まれています バージョン順を反転させる それがそうです。典型的な使い方：

:tocdepth: 1

.. toctree::

.. bokeh-releases::

孤立ファイルに関する警告を避けるためには、以下をSphinxに追加してください conf.py ファイル：

exclude_patterns = ['docs/releases/*']

bokeh_sitemap

1つを生成する sitemap.txt インデックスの検索を支援しています

sitemap.txt 文書サイト内の全ページのプレーンテキストリストである.各URLは、テキストファイルの行にリストされています。これは機械可読であり、どのページがインデックスに使用できるかを知るために検索エンジンによって使用される。

サイトマップの生成に必要なすべての内容は，このモジュールを列挙することである. bokeh.sphinxext.sitemap Sphinxプロファイルの拡張リストで conf.py それがそうです。

collapsible_code_block

HTMLに出力されると折り畳み可能な部分にコードブロックが表示される.

この命令は、折り畳み可能なコードブロックのためのタイトルを使用する：

.. collapsible-code-block:: python
    :heading: Some Code

            print("Hello, Bokeh!")

本指令は標準と同じである code-block Sphinxによって提供された指示には、新しいオプションが追加された。

タイトル(文字列)：

折りたたみ可能なブロックのためのタイトルが必要です。タイトルをクリックすると、ブロックが展開または折り畳みできます。

サンプル

上の連結サンプルコードは、以下の出力を生成する。

Some Code 
    print("Hello, Bokeh!")