Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 2.25 KB

README.rst

File metadata and controls

83 lines (53 loc) · 2.25 KB
Raw

Foundations 2: Python

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).

Building The Documents

You will need a handfull of Python pacakges to build this project. You may want to use virtualenv to help manage those dependencies.

First step is to clone this repository:

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

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

$ pip install -r requirements.txt

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

$ make 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.

Or the html5 slides:

$ 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.

License

Copyright 2014 Christopher Barker and Cris Ewing.

Thanks to Jon Jacky and Brian Dorsey, who developed the materials from which this course was derived.

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.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