← Back to branch summary

~ubuntu-branches/ubuntu/quantal/python-django/quantal-security

« back to all changes in this revision

Viewing changes to docs/intro/whatsnext.txt

  • Committer: Bazaar Package Importer
  • Author(s): Jamie Strandboge
  • Date: 2010-10-12 11:34:35 UTC
  • mfrom: (4.4.9 sid)
  • mto: This revision was merged to the branch mainline in revision 30.
  • Revision ID: james.westby@ubuntu.com-20101012113435-5rk3p18nyanuhj6g
* SECURITY UPDATE: XSS in CSRF protections. New upstream release
  - CVE-2010-3082
* debian/patches/01_disable_url_verify_regression_tests.diff:
  - updated to disable another test that fails without internet connection
  - patch based on work by Kai Kasurinen and Krzysztof Klimonda
* debian/control: don't Build-Depends on locales-all, which doesn't exist
  in maverick

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/intro/whatsnext.txt
1
 
.. _intro-whatsnext:
2
 
 
3
1
=================
4
2
What to read next
5
3
=================
6
4
 
7
 
So you've read all the :ref:`introductory material <intro-index>` and have
 
5
So you've read all the :doc:`introductory material </intro/index>` and have
8
6
decided you'd like to keep using Django. We've only just scratched the surface
9
7
with this intro (in fact, if you've read every single word you've still read
10
8
less than 10% of the overall documentation).
37
35
Django's main documentation is broken up into "chunks" designed to fill
38
36
different needs:
39
37
 
40
 
    * The :ref:`introductory material <intro-index>` is designed for people new
 
38
    * The :doc:`introductory material </intro/index>` is designed for people new
41
39
      to Django -- or to web development in general. It doesn't cover anything
42
40
      in depth, but instead gives a high-level overview of how developing in
43
41
      Django "feels".
44
42
 
45
 
    * The :ref:`topic guides <topics-index>`, on the other hand, dive deep into
 
43
    * The :doc:`topic guides </topics/index>`, on the other hand, dive deep into
46
44
      individual parts of Django. There are complete guides to Django's
47
 
      :ref:`model system <topics-db-index>`, :ref:`template engine
48
 
      <topics-templates>`, :ref:`forms framework <topics-forms-index>`, and much
 
45
      :doc:`model system </topics/db/index>`, :doc:`template engine
 
46
      </topics/templates>`, :doc:`forms framework </topics/forms/index>`, and much
49
47
      more.
50
48
 
51
49
      This is probably where you'll want to spend most of your time; if you work
53
51
      everything there is to know about Django.
54
52
 
55
53
    * Web development is often broad, not deep -- problems span many domains.
56
 
      We've written a set of :ref:`how-to guides <howto-index>` that answer
 
54
      We've written a set of :doc:`how-to guides </howto/index>` that answer
57
55
      common "How do I ...?" questions. Here you'll find information about
58
 
      :ref:`generating PDFs with Django <howto-outputting-pdf>`, :ref:`writing
59
 
      custom template tags <howto-custom-template-tags>`, and more.
 
56
      :doc:`generating PDFs with Django </howto/outputting-pdf>`, :doc:`writing
 
57
      custom template tags </howto/custom-template-tags>`, and more.
60
58
 
61
 
      Answers to really common questions can also be found in the :ref:`FAQ
62
 
      <faq-index>`.
 
59
      Answers to really common questions can also be found in the :doc:`FAQ
 
60
      </faq/index>`.
63
61
 
64
62
    * The guides and how-to's don't cover every single class, function, and
65
63
      method available in Django -- that would be overwhelming when you're
66
64
      trying to learn. Instead, details about individual classes, functions,
67
 
      methods, and modules are kept in the :ref:`reference <ref-index>`. This is
 
65
      methods, and modules are kept in the :doc:`reference </ref/index>`. This is
68
66
      where you'll turn to find the details of a particular function or
69
67
      whathaveyou.
70
68
 
71
69
    * Finally, there's some "specialized" documentation not usually relevant to
72
 
      most developers. This includes the :ref:`release notes <releases-index>`,
73
 
      :ref:`documentation of obsolete features <obsolete-index>`,
74
 
      :ref:`internals documentation <internals-index>` for those who want to add
75
 
      code to Django itself, and a :ref:`few other things that simply don't fit
76
 
      elsewhere <misc-index>`.
 
70
      most developers. This includes the :doc:`release notes </releases/index>`,
 
71
      :doc:`documentation of obsolete features </obsolete/index>`,
 
72
      :doc:`internals documentation </internals/index>` for those who want to add
 
73
      code to Django itself, and a :doc:`few other things that simply don't fit
 
74
      elsewhere </misc/index>`.
77
75
 
78
76
 
79
77
How documentation is updated
187
185
 
188
186
    * The HTML documentation will be placed in ``docs/_build/html``.
189
187
 
190
 
.. warning::
 
188
.. note::
191
189
 
192
 
    At the time of this writing, Django's using a version of Sphinx not
193
 
    yet released, so you'll currently need to install Sphinx from the
194
 
    source. We'll fix this shortly.
 
190
    Generation of the Django documentation will work with Sphinx version 0.6
 
191
    or newer, but we recommend going straight to Sphinx 1.0.2 or newer.
195
192
 
196
193
__ http://sphinx.pocoo.org/
197
194
__ http://www.gnu.org/software/make/