In order to help automate and simplify the generation of Bokeh documentation, several Sphinx extensions have been created. Most of these will not be of general interest, except for bokeh.sphinxext.bokeh_plot, which allows anyone to include and embed bokeh plots directly in their own Sphinx docs.
Integrate Bokeh extensions into Sphinx autodoc.
Ensures that autodoc directives such as autoclass automatically make use of Bokeh-specific directives when appropriate. The following Bokeh extensions are configured:
autoclass
bokeh_color
bokeh_enum
bokeh_model
bokeh_prop
Document Bokeh named colors.
The bokeh-color directive accepts a named color as its argument:
bokeh-color
.. bokeh-color:: aliceblue
and generates a labeled color swatch as output.
aliceblue
The bokeh-color direction may be used explicitly, but it can also be used in conjunction with the bokeh_autodoc extension.
Thoroughly document Bokeh enumerations
The bokeh-enum directive generates useful documentation for enumerations, including all the allowable values. If the number of values is large, the full list is put in a collapsible code block.
bokeh-enum
This directive takes the name of a Bokeh enum variable as the argument and the module name as an option. An optional description may be added as content:
.. bokeh-enum:: baz :module: bokeh.sphinxext.sample Specify a baz style
Examples
The directive above will generate the following output:
baz = Enumeration(a, b, c)¶ Specify a baz style
baz
Specify a baz style
Although bokeh-enum may be used explicitly, it is more often convenient in conjunction with the bokeh_autodoc extension. Together, the same output above will be generated directly from the following code:
#: Specify a baz style baz = enumeration("a", "b", "c")
Generate a gallery of Bokeh plots from a configuration file.
Simplify linking to Bokeh Github resources.
This module proved four new roles that can be uses to easily link to various resources in the Bokeh Github repository:
:bokeh-commit: : link to a specific commit
:bokeh-commit:
:bokeh-issue: : link to an issue
:bokeh-issue:
:bokeh-pull: : link to a pull request
:bokeh-pull:
:bokeh-tree: : (versioned) link to a source tree URL
:bokeh-tree:
The following code:
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.
yields the output:
The repo history shows that commit bf19bcb was made in in pull request 1698,which closed #1694. This included updating all of the files in the examples subdirectory.
Automatically document Bokeh Jinja2 templates.
This directive takes the module path to an attribute name that defines a Jinja2 template:
.. bokeh-jinja:: bokeh.core.templates.FILE
Any template parameters will be displayed and the template source code will be rendered in a collapsible code block. For example, the usage above will generate the following output:
FILE = <Template 'file.html'> Renders Bokeh models into a basic .html file. Parameters title (str) – value for <title> tags plot_resources (str) – typically the output of RESOURCES plot_script (str) – typically the output of PLOT_SCRIPT Users can customize the file output by providing their own Jinja2 template that accepts these same parameters. 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>
FILE
Renders Bokeh models into a basic .html file.
title (str) – value for <title> tags
<title>
plot_resources (str) – typically the output of RESOURCES
plot_script (str) – typically the output of PLOT_SCRIPT
Users can customize the file output by providing their own Jinja2 template that accepts these same parameters.
{% 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>
Thoroughly document Bokeh model classes.
The bokeh-model directive will automatically document all the attributes (including Bokeh properties) of a Bokeh Model subclass. A JSON prototype showing all the possible JSON fields will also be generated.
bokeh-model
This directive takes the name of a Bokeh model class as an argument and its module as an option:
.. bokeh-model:: Foo :module: bokeh.sphinxext.sample
For the following definition of bokeh.sphinxext.sample.Foo:
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")
the above usage yields the output:
class Foo(**kwargs)[source]¶ Bases: bokeh.model.Model This is a Foo model. index¶ property type: Either ( Auto , Enum ( Enumeration(abc, def, xzy) ) ) doc for index js_event_callbacks¶ property type: Dict ( String , List ( Instance ( CustomJS ) ) ) A mapping of event names to lists of CustomJS callbacks. Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_event method: callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback) js_property_callbacks¶ property type: Dict ( String , List ( Instance ( CustomJS ) ) ) A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created. Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method: callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback) name¶ property type: String An arbitrary, user-supplied name for this model. This name can be useful when querying the document to retrieve specific Bokeh models. >>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)] Note No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason. subscribed_events¶ property type: List ( String ) List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model. tags¶ property type: List ( Any ) An optional list of arbitrary, user-supplied values to attach to this model. This data can be useful when querying the document to retrieve specific Bokeh models: >>> 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', ...)] Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc. Note No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason. value¶ property type: Tuple ( Float , Float ) doc for value apply_theme(property_values)¶ Apply a set of theme values which will be used rather than defaults, but will not override application-set values. The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it). Parameters property_values (dict) – theme values to use in place of defaults Returns None classmethod dataspecs()¶ Collect the names of all DataSpec properties on this class. This method always traverses the class hierarchy and includes properties defined on any parent classes. Returns names of DataSpec properties Return type set[str] classmethod dataspecs_with_props()¶ Collect a dict mapping the names of all DataSpec properties on this class to the associated properties. This method always traverses the class hierarchy and includes properties defined on any parent classes. Returns mapping of names and DataSpec properties Return type dict[str, DataSpec] equals(other)¶ Structural equality of models. Parameters other (HasProps) – the other instance to compare to Returns True, if properties are structurally equal, otherwise False js_link(attr, other, other_attr, attr_selector=None)¶ Link two Bokeh model properties using JavaScript. This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value. Parameters attr (str) – The name of a Bokeh property on this model other (Model) – A Bokeh model to link to self.attr other_attr (str) – The property on other to link together attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr Added in version 1.1 Raises ValueError – Examples This code with js_link: select.js_link('value', plot, 'sizing_mode') is equivalent to the following: from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) ) Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range: range_slider.js_link('value', plot.x_range, 'start', attr_selector=0) which is equivalent to: 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)¶ Attach a CustomJS callback to an arbitrary BokehJS model event. On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically: # these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback) However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source: source.js_on_change('streaming', callback) layout(side, plot)¶ classmethod lookup(name)¶ Find the PropertyDescriptor for a Bokeh property on a class, given the property name. Parameters name (str) – name of the property to search for Returns descriptor for property named name Return type PropertyDescriptor on_change(attr, *callbacks)¶ Add a callback on this object to trigger when attr changes. Parameters attr (str) – an attribute name on this object *callbacks (callable) – callback functions to register Returns None Example: widget.on_change('value', callback1, callback2, ..., callback_n) classmethod properties(with_bases=True)¶ Collect the names of properties on this class. This method optionally traverses the class hierarchy and includes properties defined on any parent classes. Parameters with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True) Returns property names Return type set[str] classmethod properties_containers()¶ Collect the names of all container properties on this class. This method always traverses the class hierarchy and includes properties defined on any parent classes. Returns names of container properties Return type set[str] classmethod properties_with_refs()¶ Collect the names of all properties on this class that also have references. This method always traverses the class hierarchy and includes properties defined on any parent classes. Returns names of properties that have references Return type set[str] properties_with_values(include_defaults=True)¶ Collect a dict mapping property names to their values. This method always traverses the class hierarchy and includes properties defined on any parent classes. Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance. Parameters include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True) Returns mapping from property names to their values Return type dict query_properties_with_values(query, include_defaults=True)¶ Query the properties values of HasProps instances with a predicate. Parameters query (callable) – A callable that accepts property descriptors and returns True or False include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True) Returns mapping of property names and values for matching properties Return type dict references()¶ Returns all Models that this object has references to. remove_on_change(attr, *callbacks)¶ Remove a callback from this object select(selector)¶ Query this object and all of its references for objects that match the given selector. Parameters selector (JSON-like) – Returns seq[Model] select_one(selector)¶ Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like Returns Model set_from_json(name, json, models=None, setter=None)¶ Set a property value on this object from JSON. Parameters name – (str) : name of the attribute to set json – (JSON-value) : value to set to the attribute to models (dict or None, optional) – Mapping of model ids to models (default: None) This is needed in cases where the attributes to update also have values that have references. setter (ClientSession or ServerSession or None, optional) – This is used to prevent “boomerang” updates to Bokeh apps. In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself. Returns None set_select(selector, updates)¶ Update objects that match a given selector with the specified attribute/value updates. Parameters selector (JSON-like) – updates (dict) – Returns None themed_values()¶ Get any theme-provided overrides. Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance. Returns dict or None to_json(include_defaults)¶ Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list). References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects. There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references). For most purposes it’s best to serialize and deserialize entire documents. Parameters include_defaults (bool) – whether to include attributes that haven’t been changed from the default to_json_string(include_defaults)¶ Returns a JSON string encoding the attributes of this object. References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects. There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references). For most purposes it’s best to serialize and deserialize entire documents. Parameters include_defaults (bool) – whether to include attributes that haven’t been changed from the default trigger(attr, old, new, hint=None, setter=None)¶ unapply_theme()¶ Remove any themed values and restore defaults. Returns None update(**kwargs)¶ Updates the object’s properties from the given keyword arguments. Returns None Examples The following are equivalent: 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)¶ Updates the object’s properties from a JSON attributes dictionary. Parameters json_attributes – (JSON-dict) : attributes and values to update models (dict or None, optional) – Mapping of model ids to models (default: None) This is needed in cases where the attributes to update also have values that have references. setter (ClientSession or ServerSession or None, optional) – This is used to prevent “boomerang” updates to Bokeh apps. In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself. Returns None property document¶ The Document this model is attached to (can be None) property struct¶ A Bokeh protocol “structure” of this model, i.e. a dict of the form: { 'type' : << view model name >> 'id' : << unique model id >> } Additionally there may be a subtype field if this model is a subtype. JSON Prototype { "id": "20547", "index": "auto", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [], "value": null }
Foo
Bases: bokeh.model.Model
bokeh.model.Model
This is a Foo model.
index
property type: Either ( Auto , Enum ( Enumeration(abc, def, xzy) ) )
Either
Auto
Enum
doc for index
js_event_callbacks
property type: Dict ( String , List ( Instance ( CustomJS ) ) )
Dict
String
List
Instance
CustomJS
A mapping of event names to lists of CustomJS callbacks.
Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_event method:
Model.js_on_event
callback = CustomJS(code="console.log('tap event occurred')") plot.js_on_event('tap', callback)
js_property_callbacks
A mapping of attribute names to lists of CustomJS callbacks, to be set up on BokehJS side when the document is created.
Typically, rather then modifying this property directly, callbacks should be added using the Model.js_on_change method:
Model.js_on_change
callback = CustomJS(code="console.log('stuff')") plot.x_range.js_on_change('start', callback)
name
property type: String
An arbitrary, user-supplied name for this model.
This name can be useful when querying the document to retrieve specific Bokeh models.
>>> plot.circle([1,2,3], [4,5,6], name="temp") >>> plot.select(name="temp") [GlyphRenderer(id='399d53f5-73e9-44d9-9527-544b761c7705', ...)]
Note
No uniqueness guarantees or other conditions are enforced on any names that are provided, nor is the name used directly by Bokeh for any reason.
subscribed_events
property type: List ( String )
List of events that are subscribed to by Python callbacks. This is the set of events that will be communicated from BokehJS back to Python for this model.
tags
property type: List ( Any )
Any
An optional list of arbitrary, user-supplied values to attach to this model.
This data can be useful when querying the document to retrieve specific Bokeh models:
>>> 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', ...)]
Or simply a convenient way to attach any necessary metadata to a model that can be accessed by CustomJS callbacks, etc.
No uniqueness guarantees or other conditions are enforced on any tags that are provided, nor are the tags used directly by Bokeh for any reason.
value
property type: Tuple ( Float , Float )
Tuple
Float
doc for value
apply_theme
Apply a set of theme values which will be used rather than defaults, but will not override application-set values.
The passed-in dictionary may be kept around as-is and shared with other instances to save memory (so neither the caller nor the HasProps instance should modify it).
HasProps
property_values (dict) – theme values to use in place of defaults
None
dataspecs
Collect the names of all DataSpec properties on this class.
DataSpec
This method always traverses the class hierarchy and includes properties defined on any parent classes.
names of DataSpec properties
set[str]
dataspecs_with_props
Collect a dict mapping the names of all DataSpec properties on this class to the associated properties.
mapping of names and DataSpec properties
dict[str, DataSpec]
equals
Structural equality of models.
other (HasProps) – the other instance to compare to
True, if properties are structurally equal, otherwise False
js_link
Link two Bokeh model properties using JavaScript.
This is a convenience method that simplifies adding a CustomJS callback to update one Bokeh model property whenever another changes value.
attr (str) – The name of a Bokeh property on this model
other (Model) – A Bokeh model to link to self.attr
other_attr (str) – The property on other to link together
other
attr_selector (Union[int, str]) – The index to link an item in a subscriptable attr
attr
Added in version 1.1
ValueError –
This code with js_link:
select.js_link('value', plot, 'sizing_mode')
is equivalent to the following:
from bokeh.models import CustomJS select.js_on_change('value', CustomJS(args=dict(other=plot), code="other.sizing_mode = this.value" ) )
Additionally, to use attr_selector to attach the left side of a range slider to a plot’s x_range:
range_slider.js_link('value', plot.x_range, 'start', attr_selector=0)
which is equivalent to:
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
Attach a CustomJS callback to an arbitrary BokehJS model event.
On the BokehJS side, change events for model properties have the form "change:property_name". As a convenience, if the event name passed to this method is also the name of a property on the model, then it will be prefixed with "change:" automatically:
"change:property_name"
"change:"
# these two are equivalent source.js_on_change('data', callback) source.js_on_change('change:data', callback)
However, there are other kinds of events that can be useful to respond to, in addition to property change events. For example to run a callback whenever data is streamed to a ColumnDataSource, use the "stream" event on the source:
ColumnDataSource
"stream"
source.js_on_change('streaming', callback)
layout
lookup
Find the PropertyDescriptor for a Bokeh property on a class, given the property name.
PropertyDescriptor
name (str) – name of the property to search for
descriptor for property named name
on_change
Add a callback on this object to trigger when attr changes.
attr (str) – an attribute name on this object
*callbacks (callable) – callback functions to register
Example:
widget.on_change('value', callback1, callback2, ..., callback_n)
properties
Collect the names of properties on this class.
This method optionally traverses the class hierarchy and includes properties defined on any parent classes.
with_bases (bool, optional) – Whether to include properties defined on parent classes in the results. (default: True)
property names
properties_containers
Collect the names of all container properties on this class.
names of container properties
properties_with_refs
Collect the names of all properties on this class that also have references.
names of properties that have references
properties_with_values
Collect a dict mapping property names to their values.
Non-serializable properties are skipped and property values are in “serialized” format which may be slightly different from the values you would normally read from the properties; the intent of this method is to return the information needed to losslessly reconstitute the object instance.
include_defaults (bool, optional) – Whether to include properties that haven’t been explicitly set since the object was created. (default: True)
mapping from property names to their values
dict
query_properties_with_values
Query the properties values of HasProps instances with a predicate.
query (callable) – A callable that accepts property descriptors and returns True or False
include_defaults (bool, optional) – Whether to include properties that have not been explicitly set by a user (default: True)
mapping of property names and values for matching properties
references
Returns all Models that this object has references to.
Models
remove_on_change
Remove a callback from this object
select
Query this object and all of its references for objects that match the given selector.
selector (JSON-like) –
seq[Model]
select_one
Query this object and all of its references for objects that match the given selector. Raises an error if more than one object is found. Returns single matching object, or None if nothing is found :param selector: :type selector: JSON-like
Model
set_from_json
Set a property value on this object from JSON.
name – (str) : name of the attribute to set
json – (JSON-value) : value to set to the attribute to
models (dict or None, optional) –
Mapping of model ids to models (default: None)
This is needed in cases where the attributes to update also have values that have references.
setter (ClientSession or ServerSession or None, optional) –
This is used to prevent “boomerang” updates to Bokeh apps.
In the context of a Bokeh server application, incoming updates to properties will be annotated with the session that is doing the updating. This value is propagated through any subsequent change notifications that the update triggers. The session can compare the event setter to itself, and suppress any updates that originate from itself.
set_select
Update objects that match a given selector with the specified attribute/value updates.
updates (dict) –
themed_values
Get any theme-provided overrides.
Results are returned as a dict from property name to value, or None if no theme overrides any values for this instance.
dict or None
to_json
Returns a dictionary of the attributes of this object, containing only “JSON types” (string, number, boolean, none, dict, list).
References to other objects are serialized as “refs” (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json()
For most purposes it’s best to serialize and deserialize entire documents.
include_defaults (bool) – whether to include attributes that haven’t been changed from the default
to_json_string
Returns a JSON string encoding the attributes of this object.
References to other objects are serialized as references (just the object ID and type info), so the deserializer will need to separately have the full attributes of those other objects.
There’s no corresponding from_json_string() because to deserialize an object is normally done in the context of a Document (since the Document can resolve references).
from_json_string()
trigger
unapply_theme
Remove any themed values and restore defaults.
update
Updates the object’s properties from the given keyword arguments.
The following are equivalent:
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
Updates the object’s properties from a JSON attributes dictionary.
json_attributes – (JSON-dict) : attributes and values to update
document
The Document this model is attached to (can be None)
Document
struct
A Bokeh protocol “structure” of this model, i.e. a dict of the form:
{ 'type' : << view model name >> 'id' : << unique model id >> }
Additionally there may be a subtype field if this model is a subtype.
{ "id": "20547", "index": "auto", "js_event_callbacks": {}, "js_property_callbacks": {}, "name": null, "subscribed_events": [], "tags": [], "value": null }
The bokeh-model direction may be used explicitly, but it can also be used in conjunction with the bokeh_autodoc extension.
Thoroughly document Bokeh options classes.
The bokeh-options directive will automatically document all the properties of a Bokeh Options class under a heading of “Keyword Args”.
bokeh-options
This directive takes the name of a Bokeh Options subclass as the argument, and its module as an option:
.. bokeh-options:: Opts :module: bokeh.sphinxext.sample
For the following definition of bokeh.sphinxext.sample.Opts:
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")
Keyword Args: host (String ) : a host to connect to (default: ‘localhost’) port (Int ) : a port to connect to (default: 5890)
Keyword Args:
host (String ) : a host to connect to (default: ‘localhost’) port (Int ) : a port to connect to (default: 5890)
host (String ) : a host to connect to (default: ‘localhost’)
port (Int ) : a port to connect to (default: 5890)
Int
Generate an inline visual representations of a single color palette.
The :bokeh-palette: role can be used with by providing any of the following:
:bokeh-palette:
a palette name from bokeh.palettes, e.g. Spectral9
bokeh.palettes
Spectral9
a palette function from bokeh.palettes called with argument, e.g. viridis(12)
viridis(12)
An explicit list of colors: ['#000000', '#333333', '#666666', '#999999', '#cccccc', '#ffffff']
['#000000', '#333333', '#666666', '#999999', '#cccccc', '#ffffff']
The following usage of the the directive:
* by name: :bokeh-palette:`Spectral9` * by function: :bokeh-palette:`viridis(12)` * by list: :bokeh-palette:`['#000000', '#333333', '#666666', '#999999', '#cccccc', '#ffffff']`
Generates the output:
by name: by function: by list:
by name:
by function:
by list:
Palette swatches are 20 pixels in height. For palettes short than 20 colors, the default width for the swatches is 20 pixels. If larger palettes are given, the width of the HTML spans is progressively reduced, down to a minimum of one pixel. For instance displaying the full Viridis palette with the expression
:bokeh-palette:`viridis(256)`
Will generate the output:
Generate visual representations of palettes in Bokeh palette groups.
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.
mpl
brewer
d3
bokeh-palette-group
As an example, the following usage of the the directive:
.. 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
This extension assumes both Bootstrap and JQuery are present (which is the case for the Bokeh documentation theme). If using this theme outside the Bokeh documentation, be sure to include those resources by hand.
Include Bokeh plots in Sphinx HTML documentation.
For other output types, the placeholder text [graph] will be generated.
[graph]
The bokeh-plot directive can be used by either supplying:
bokeh-plot
A path to a source file as the argument to the directive:
.. bokeh-plot:: path/to/plot.py
.py scripts are not scanned automatically! In order to include certain directories into .py scanning process use following directive in sphinx conf.py file: bokeh_plot_pyfile_include_dirs = [“dir1”,”dir2”]
Inline code as the content of the directive:
.. 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)
This directive also works in conjunction with Sphinx autodoc, when used in docstrings.
The bokeh-plot directive accepts the following options:
Where to locate the the block of formatted source code (if anywhere).
Whether to display line numbers along with the source.
The inline example code above produces the following output:
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)
Thoroughly document Bokeh property attributes.
The bokeh-prop directive generates documentation for Bokeh model properties, including cross links to the relevant property types. Additionally, any per-attribute help strings are also displayed.
bokeh-prop
This directive takes the name (class.attr) of a Bokeh property as its argument and the module as an option:
.. bokeh-prop:: Bar.thing :module: bokeh.sphinxext.sample
For the following definition of bokeh.sphinxext.sample.Bar:
bokeh.sphinxext.sample.Bar
class Bar(Model): """ This is a Bar model. """ thing = List(Int, help="doc for thing")
thing¶ property type: List ( Int ) doc for thing
thing
property type: List ( Int )
doc for thing
The bokeh-prop direction may be used explicitly, but it can also be used in conjunction with the bokeh_autodoc extension.
Publish all Bokeh release notes on to a single page.
This directive collect all the release notes files in the docs/releases subdirectory, and includes them in reverse version order. Typical usage:
docs/releases
:tocdepth: 1 .. toctree:: .. bokeh-releases::
To avoid warnings about orphaned files, add the following to the Sphinx conf.py file:
conf.py
exclude_patterns = ['docs/releases/*']
Generate a sitemap.txt to aid with search indexing.
sitemap.txt
sitemap.txt is a plain text list of all the pages in the docs site. Each URL is listed on a line in the text file. It is machine readable and used by search engines to know what pages are available for indexing.
All that is required to generate the sitemap is to list this module bokeh.sphinxext.sitemap in the list of extensions in the Sphinx configuration file conf.py.
bokeh.sphinxext.sitemap
Display code blocks in collapsible sections when outputting to HTML.
This directive takes a heading to use for the collapsible code block:
.. collapsible-code-block:: python :heading: Some Code print("Hello, Bokeh!")
This directive is identical to the standard code-block directive that Sphinx supplies, with the addition of one new option:
code-block
A heading to put for the collapsible block. Clicking the heading expands or collapses the block.
print("Hello, Bokeh!")