atenni / python-user-guide

The Official User-Guide to Plotly's Python API

Plotly's Python API User Guide

Welcome to Plotly's Python API User Guide!

The User Guide was written with the goal of giving Plotly Python (and IPython) users extensive documentation on almost all of Plotly's features.

In Brief:

The User Guide is entirely written inside IPython notebooks.

This repository is divided into folders, one for each section or appendix. Each folder contains one or several IPython notebooks and the required data files to run them.

This repository implements a handful of scripts (notably using nbconvert) with the purpose of the User Guide's notebook to publishable HTML files constituting the backbone of the Python API User Guide section of plot.ly.

The User Guide's homepage resides on plot.ly/python/user-guide.

Refer to Contributing.md for more.

Folders and files in this repo

• s00_homepage/, s0_getting_started/, ... : Sections of the user guide.

• Index.ipynb : notebook listing the content of the user guide

• Contributing.md : instructions for potential contributers

• makefile : implements scripts in scripts/

• scripts/ : scripts used in the notebook-to-published HTML process

• published/ : plot.ly-ready published content

• custom.css : CSS file for notebook styling

• templates/ : user guide templates (coming soon)

Got Questions and Feedback?

• About Plotly email at [e-mail] or tweet at @plotlygraphs

• About the User Guide email at [e-mail] or tweet at @etpinard