mihi-tr / datawrangling Goto Github PK

Welcome to the source text of the Data Wrangling Handbook. The handbook is a project of the Open Knowledge Foundation. If you are reading this it is likely you are looking to contribute in some way, whether that's translation, feedback, editing or adding more content. If you just want to read the handbook, then please head over to the http://handbook.schoolofdata.org/.

We have several ways you can help. The project is split into a few roles. Our authors write content, editors merge those submissions into the handbook, designers help beautify it and translators bring the handbook to all countries of the world.

If you are interested in contributing please either open an issue or get in contact on the mailing list.

The handbook is written the ReStructured Text format. ReStructured Text allows us to write files in plain text files, which can be nicely rendered as a website or a PDF using Sphinx.

Outline:

datawrangling/
  text/
  examples
  bin/
  build/

Details:

1. Move into the base directory of the project:

   cd datawrangling
   

2. Install Sphinx, with a minimum version of 1.0. Instructions for Debian and Ubuntu:

   apt-get install python-sphinx
   

3. Make sure you have installed the theme by initializing the git submodules for this repo:

   git submodule init
   git submodule update
   

4. Render the HTML, using make:

   make html
   

We use ReadTheDocs to host the handbook. ReadTheDocs will automatically rebuild the site each time you push a change to the master branch.