sphinx-plotly-directive 0.1.1

A directive for including a plotly figure in a Sphinx document

sphinx-plotly-directive

A directive for including a Plotly figure in a Sphinx document.

Based on matplotlib's plot directive.

Install

# pypi
pip install sphinx-plotly-directive

# dev version
pip install git+https://github.com/harupy/sphinx-plotly-directive.git

Usage

Source:

.. plotly::

   import plotly.express as px
   px.scatter(x=[0, 1, 2, 3, 4], y=[0, 1, 4, 9, 16])

The last line of a code block must end with an expression that evaluates to a plotly figure.

Output:

See documentation for details.

Development

Install dependencies

pip install -e ".[dev]"

Format code

flake8 .
isort .
black .

Run tests

pytest tests

Build document

cd docs
make html