Redux documentation for Dash

Installation in Dash

To install the Redux documentation in Dash, go to:

Preferences >> Downloads >> User Contributed

This repo is used to generate those docs. You don't need to touch it unless you want to contribute to it.

To update the docset, please read the instructions here (more specifically, "Set up your directory structure"). To generate the docset for your Dash-User-Contributions pull request, you'd use this repo.

Note: If you do wish to update the docset, please notify me by opening an issue. I'd like to double check everything before you send it off to the Dash repo.

Docset Manual Build Instructions

Prerequisites: wget, node and sqlite3. For OS X:

brew install wget node sqlite3

Clone this repo, cd into it and do:

npm install
chmod 777 build.sh
./build.sh

The script will:

• Fetch the newest released Redux documentation from https://github.com/reactjs/redux/.
• Parse the doc site into a new SQLite database for Dash. The list of files are hardcoded. Please check src/index.js for more detail.
• Bundle up the result in a Redux.docset.
• GZip for Dash contribution

Test the output by loading the Redux.docset (importing it into Dash).