A directive for including a plotly figure in a Sphinx document
Project description
sphinx-plotly-directive
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
Built Distribution
File details
Details for the file sphinx-plotly-directive-0.1.2.tar.gz
.
File metadata
- Download URL: sphinx-plotly-directive-0.1.2.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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64f04f30cfc520d9a7cf8102de45a0005cad020ac0642bb3c7b2d9dad3fb506f |
|
MD5 | f74b86317bda4e824845ed6f0b87f954 |
|
BLAKE2b-256 | 78c1da73d6c9d4041701fa3077f362abe92e5041efa9e12ffbea3f2a40d2d571 |
File details
Details for the file sphinx_plotly_directive-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: sphinx_plotly_directive-0.1.2-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
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee283a9630992e436c9f318fc7628934980fcd554bb359372c5a8ca14f204fb8 |
|
MD5 | d881d9a7452a75caff540f7bcb49e708 |
|
BLAKE2b-256 | 31aa19de85f34aeff00c14adfbac618f77aa58539209bdd81d590ca7ffeb3b89 |