This repository houses presentations and class materials for the Code Fellows Foundations 2 course in Python programming.

The documentation is written in ReStructuredText and output formats are included for html, epub and html5slides (via the excellent hieroglyph package).

To build this documentation, begin by cloning the repository:

$ git clone https://github.com/cewing/codefellows_f2_python.git
...
$ cd codefellows_f2_python

To isolate the packages required from your system Python, create a virtualenv. I highly recommend using virtualenvwrapper to manage your virtual environmants:

$ mkvirtualenv codefellows_f2_python
New python executable in codefellows_f2_python/bin/python
Installing setuptools, pip...done.
[codefellows_f2_python]$

Once that is complete, you can install all the required packages with pip:

[codefellows_f2_python]$ pip install -r requirements.txt

Finally, build the documentation using one of the output targets. To build the plain html version, for example:

[codefellows_f2_python]$ make htmlmake html
sphinx-build -b html -d build/doctrees   source build/html
Running Sphinx v1.2.2
...
build succeeded.

Build finished. The HTML pages are in build/html.
[codefellows_f2_python]$

Or the html5 slides:

[codefellows_f2_python]$ make slides
sphinx-build -b slides -d build/doctrees   source build/slides
Running Sphinx v1.2.2
...
Build finished. The HTML slides are in build/slides.

Or the epub documentation:

[codefellows_f2_python]$ make epub
sphinx-build -b epub -d build/doctrees   source build/epub
Running Sphinx v1.2.2
...
Build finished. The epub file is in build/epub.
[codefellows_f2_python]

This work is copyright Cris Ewing and Christopher Barker and licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.

A copy of this license in text format is included in this package under the docs directory