Metadata-Version: 2.1
Name: sphinx-plotly-directive
Version: 0.1.0
Summary: A directive for including a plotly figure in a Sphinx document
Home-page: https://github.com/harupy/sphinx-plotly-directive
Maintainer: harupy
Maintainer-email: hkawamura0130@gmail.com
License: UNKNOWN
Description: # sphinx-plotly-directive
        
        ![CI](https://github.com/harupy/sphinx-plotly-directive/workflows/CI/badge.svg)
        [![Documentation Status](https://readthedocs.org/projects/sphinx-plotly-directive/badge/?version=latest)](https://sphinx-plotly-directive.readthedocs.io/en/latest/?badge=latest)
        
        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
        ```
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
