Skip to main content

A directive for including a plotly figure in a Sphinx document

Project description

sphinx-plotly-directive

pypi badge CI Documentation Status Imports: isort Code style: black

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

This package is 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])

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-plotly-directive-0.1.3.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

sphinx_plotly_directive-0.1.3-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-plotly-directive-0.1.3.tar.gz.

File metadata

  • Download URL: sphinx-plotly-directive-0.1.3.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.9

File hashes

Hashes for sphinx-plotly-directive-0.1.3.tar.gz
Algorithm Hash digest
SHA256 95a49e4ab96d311afcd801e965f0adfbcd21334c17bbb2ca7d3a2161fdc60b01
MD5 0b600612115a42c126f954a5d29d4e6a
BLAKE2b-256 8056c1a735382c92894ebea3214384494ae114f59201f0a66ded97873950fcd6

See more details on using hashes here.

File details

Details for the file sphinx_plotly_directive-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: sphinx_plotly_directive-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0.post20201006 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.9

File hashes

Hashes for sphinx_plotly_directive-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 030df1d817a8668ba63db0f491879d9d3f32ebb0266c59266b2fac99c88eed86
MD5 6e1476ba2ba0f426f86b3809ef630f81
BLAKE2b-256 533de875270e1de54960bce4663c1ab9ef8d530c26cab5895a0e72b1a22d0b62

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page