https://github.com/nyergler/effective-django

Documentation on effectively using Django for building web applications.
https://github.com/nyergler/effective-django

Last synced: 2 months ago
JSON representation

Documentation on effectively using Django for building web applications.

• Host: GitHub
• URL: https://github.com/nyergler/effective-django
• Owner: nyergler
• License: other
• Archived: true
• Created: 2012-03-07T05:56:51.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2020-06-05T16:59:00.000Z (over 4 years ago)
• Last Synced: 2024-08-04T04:05:09.467Z (6 months ago)
• Language: Python
• Homepage:
• Size: 4.95 MB
• Stars: 175
• Watchers: 16
• Forks: 34
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - effective-django - Documentation on effectively using Django for building web applications. (Python)

README

        
==================

 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:

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

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

#. Create a virtualenv_ and install the dependencies::

     $ virtualenv .

     $ . bin/activate

     $ pip install -r requirements.txt

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

.. _`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/