Skip to content

Sphinx extension for python-nvd3

License

Notifications You must be signed in to change notification settings

Work4Labs/sphinxcontrib.nvd3

 
 

Repository files navigation

sphinxcontrib.nvd3

Sphinx chart extension using NVD3.

Feature

  • provide some kinds of nvd3- prefixed directives to generate SVG chart from source.

Installation

Install with pip:

$ pip install sphinxcontrib.nvd3

setup conf.py with:

extensions = ["sphinxcontrib.nvd3"]

This package is NOT includes Javascript and CSS files (e.g. d3.js, nvd3.js and nvd3.css).

You need to add setup function into conf.py, as below:

def setup(app):
    app.add_javascript("/path/to/d3.v3.js")
    app.add_javascript("/path/to/nv.d3.js")
    app.add_stylesheet("/path/to/nv.d3.css")

And then:

$ make html

Requirement

  • python-nvd3 >= 0.3.16
  • D3.js >= 3.x
  • Sphinx >= 1.3

License

Licensed under the Apache Software License . See the LICENSE file for specific terms.

About

Sphinx extension for python-nvd3

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%