Documentation on effectively using Django for building web applications.
Python Makefile CSS HTML
Latest commit 7392174 Nov 25, 2015 @nyergler Merge pull request #22 from romgar/fix_orm_documentation
Fix #14 by removing wrong statements about save() method.
Permalink
Failed to load latest commit information.
_build @ 52bdd85 Update _build pointer. Oct 19, 2015
_static First draft, login/logout using django.contrib.auth Nov 18, 2013
_templates Remove busted GA extension and move configuration to template. Jun 30, 2015
handouts Adding snapshots of the handouts tutorial attendees have received. Jul 11, 2013
scratchpad Cleaning up warning-generating issues. Mar 31, 2013
src @ 1685ced Update src pointer. Mar 10, 2015
tutorial non_field_errors belong to the form. Oct 19, 2015
.gitignore Update ignore patterns. Oct 19, 2015
.gitmodules Add _build as a submodule pointing at gh_pages. Mar 10, 2015
.nojekyll Copy .nojekyll to _build on Sphinx build. Mar 10, 2015
CNAME Copy extra files to the build directory on run. Mar 10, 2015
LICENSE Adding CC BY-SA 4.0 License. Jan 9, 2014
Makefile Add flymake support to the Makefile. Nov 25, 2015
README.rst RST formatting. Oct 19, 2015
acknowledgments.rst Updated acknowledgments. Apr 11, 2013
classbasedviews.rst Updating notes for Django 1.5. Apr 11, 2013
conf.py Remove busted GA extension and move configuration to template. Jun 30, 2015
forms.rst Non field errors are on the form, not field. Oct 19, 2015
further-reading.rst Added acknowledgments. Apr 2, 2013
index.rst Removed errand bracket, looks like mistype. Aug 13, 2015
intro.rst Cleaning up warning-generating issues. Mar 31, 2013
middleware.rst Updating notes for Django 1.5. Apr 11, 2013
orm.rst Fix #14 by removing wrong statements about save() method, and adding … Nov 25, 2015
requirements.txt Bump blockdiag version. Oct 19, 2015
settings.py Fix all existing doctests. Jul 29, 2012
testing.rst Removing explicit Next links from the bottom of documents. Jul 30, 2012

README.rst

Effective Django

This is the repository for the text Effective Django, an ongoing work in progress by Nathan Yergler. The sample code is maintained in the effective-django-tutorial repository.

Effective Django is authored using ReStructured Text and Sphinx. If you're interested in building HTML, PDF, ePub, or other generated formats, you can do so by:

  1. If you want to build PDF or ePub output, make sure LaTeX is installed on your machine. If you only care about HTML output, you can skip this step.

    For Macs, it is recommended you use MacTeX

    $ brew install Caskroom/cask/mactex
    

    If you're building on Ubuntu, you should install the texlive and texlive-latex-extra packages.

    $ sudo apt-get install texlive texlive-latex-extra
    
  2. Check out this repository:

    $ git clone --recursive https://github.com/nyergler/effective-django.git
    

    Note that in order to build Effective Django, the sample code must be cloned into the src submodule. Using --recursive will accomplish that.

  3. Create a virtualenv and install the dependencies:

    $ virtualenv .
    $ . bin/activate
    $ pip install -r requirements.txt
    
  4. Run make:

    $ make all
    

    The output will be in the _build sub-directory.

    To only build HTML, specify the target explicitly:

    $ make html
    

Run make without any parameters for a list of possible targets.