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.
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
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.0.tar.gz
.
File metadata
- Download URL: sphinx-plotly-directive-0.1.0.tar.gz
- Upload date:
- Size: 10.5 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 | 02927e4de13ee0c1ed3ecd8318b546b170504db5d185cc4f5d63eccf29dd34bf |
|
MD5 | 3c64ca259105cf9b9ccfda73ede7cf68 |
|
BLAKE2b-256 | 586454a80d43a888e5bbbfc18c0fe9e3a1370e5c0c57d88eed8ff23e66112685 |
File details
Details for the file sphinx_plotly_directive-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: sphinx_plotly_directive-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.6 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 | c65719d1dc57903049f0d1f68489ca92ed5db174c8f3481d8389e5a4c73a196b |
|
MD5 | ca5c1572f81b6df0852714d7b4970c0d |
|
BLAKE2b-256 | 7e43e387e158bb33b3deffbe1e1f6f654b9d77c660eceefa77ec9226b827c499 |