sphinx-plotly-directive 0.1.0

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.

Install

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

How to use

.. 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.

Development

Format code

flake8 .
isort .
black .

Run tests

pytest tests

Build document

cd docs
make html