Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.79 KB

README.md

File metadata and controls

27 lines (18 loc) · 1.79 KB
Raw

vega-lite-docset-generator

A Python script to generate offline documentation for vega-lite, an expressive language for building data interactive visualizations.

Features

  • In-page table of contents for all pages, including images and examples for each Vega-Lite spec property.
  • Mobile friendly layout (sidebars have been removed)
  • Quick search of all pages on the public docs page, including examples. (Note examples that load remote data require an internet connection to load normally.)

Custom Usage

This step is only necessary if you intend to modify the published docset locally. Otherwise, it can be installed from the Dash app or the Dash contributions repository.

  1. Clone vega-lite as a sibling directory of this repository using changes from this PR.
  2. In that directory, run yarn install && yarn docset to generate the site
  • You may need to install rbenv, Jekyll, and a recent version of Ruby to build the documentation site.
  1. In your python virtual environment, add python dependencies: pip install -r requirements.txt
  • Using Jupyter is optional, but recommended for ease of debugging notebook output.
  1. Run jupyter notebook, and double-click generate-vega-lite-docset.ipynb. Run all cells.
  2. Your generated docset will be this directory vega-lite.docset . Use "File > Open Local Docset" to test the file before submitting it.

See notebook for detailed instructions. The DEBUG flag can be toggled to adjust the amount of logging.

Related