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:
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
$ 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.
$ virtualenv .
$ . bin/activate
$ pip install -r requirements.txt
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.
.. Effective Django
: http://effectivedjango.com/
.. effective-django-tutorial
: https://github.com/nyergler/effective-django-tutorial
.. _ReStructured Text
: http://docutils.sf.net/
.. Sphinx: http://sphinx-doc.org/
.. MacTeX
: http://tug.org/mactex/
.. _virtualenv: http://www.virtualenv.org/