← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/python-django/oneiric-201108291626

« back to all changes in this revision

Viewing changes to docs/intro/whatsnext.txt

  • Committer: Bazaar Package Importer
  • Author(s): Chris Lamb
  • Date: 2010-05-21 07:52:55 UTC
  • mfrom: (1.1.10 upstream) (4.4.7 sid)
  • Revision ID: james.westby@ubuntu.com-20100521075255-i1zpeyc0k8512pd7
Tags: 1.2-1
New upstream stable release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/intro/whatsnext.txt
41
41
      to Django -- or to web development in general. It doesn't cover anything
42
42
      in depth, but instead gives a high-level overview of how developing in
43
43
      Django "feels".
44
 
      
 
44
 
45
45
    * The :ref:`topic guides <topics-index>`, on the other hand, dive deep into
46
46
      individual parts of Django. There are complete guides to Django's
47
47
      :ref:`model system <topics-db-index>`, :ref:`template engine
48
48
      <topics-templates>`, :ref:`forms framework <topics-forms-index>`, and much
49
49
      more.
50
 
      
51
 
      This is probably where you'll want to spent most of your time; if you work
 
50
 
 
51
      This is probably where you'll want to spend most of your time; if you work
52
52
      your way through these guides you should come out knowing pretty much
53
53
      everything there is to know about Django.
54
54
 
67
67
      methods, and modules are kept in the :ref:`reference <ref-index>`. This is
68
68
      where you'll turn to find the details of a particular function or
69
69
      whathaveyou.
70
 
    
 
70
 
71
71
    * Finally, there's some "specialized" documentation not usually relevant to
72
72
      most developers. This includes the :ref:`release notes <releases-index>`,
73
73
      :ref:`documentation of obsolete features <obsolete-index>`,
74
74
      :ref:`internals documentation <internals-index>` for those who want to add
75
75
      code to Django itself, and a :ref:`few other things that simply don't fit
76
76
      elsewhere <misc-index>`.
77
 
      
 
77
 
78
78
 
79
79
How documentation is updated
80
80
============================
160
160
.. code-block:: bash
161
161
 
162
162
    $ grep -r max_length /path/to/django/docs/
163
 
    
 
163
 
164
164
As HTML, locally
165
165
----------------
166
166
 
170
170
      plain text to HTML. You'll need to install Sphinx by either downloading
171
171
      and installing the package from the Sphinx website, or by Python's
172
172
      ``easy_install``:
173
 
      
 
173
 
174
174
      .. code-block:: bash
175
 
        
 
175
 
176
176
            $ easy_install Sphinx
177
 
    
 
177
 
178
178
    * Then, just use the included ``Makefile`` to turn the documentation into
179
179
      HTML:
180
 
      
 
180
 
181
181
      .. code-block:: bash
182
 
      
 
182
 
183
183
            $ cd path/to/django/docs
184
184
            $ make html
185
 
    
 
185
 
186
186
      You'll need `GNU Make`__ installed for this.
187
 
      
 
187
 
188
188
    * The HTML documentation will be placed in ``docs/_build/html``.
189
 
    
 
189
 
190
190
.. warning::
191
191
 
192
192
    At the time of this writing, Django's using a version of Sphinx not
193
193
    yet released, so you'll currently need to install Sphinx from the
194
194
    source. We'll fix this shortly.
195
 
    
 
195
 
196
196
__ http://sphinx.pocoo.org/
197
197
__ http://www.gnu.org/software/make/
198
198