Django

Code

Changeset 8506

Show
Ignore:
Timestamp:
08/23/08 17:25:40 (10 months ago)
Author:
jacob
Message:

Massive reorganization of the docs. See the new docs online at http://docs.djangoproject.com/.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • django/trunk/AUTHORS

    r8497 r8506  
    6868    Ned Batchelder <http://www.nedbatchelder.com/> 
    6969    batiste@dosimple.ch 
     70    Batman 
    7071    Shannon -jj Behrens <http://jjinux.blogspot.com/> 
    7172    Esdras Beleza <linux@esdrasbeleza.com> 

  • django/trunk/docs/conf.py

    r7374 r8506  
    1313 
    1414import sys 
     15import os 
    1516 
    1617# If your extensions are in another directory, add it here. 
    17 #sys.path.append('some/directory') 
     18sys.path.append(os.path.join(os.path.dirname(__file__), "_ext")) 
    1819 
    1920# General configuration 
    …… 
    2223# Add any Sphinx extension module names here, as strings. They can be extensions 
    2324# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 
    24 #extensions = [] 
     25extensions = ["djangodocs"] 
    2526 
    2627# Add any paths that contain templates here, relative to this directory. 
    27 templates_path = [] 
     28templates_path = ["_templates"] 
    2829 
    2930# The suffix of source filenames. 
    …… 
    3132 
    3233# The master toctree document. 
    33 master_doc = 'index' 
     34master_doc = 'contents' 
    3435 
    3536# General substitutions. 
    3637project = 'Django' 
    37 copyright = '2008, Django Software Foundation' 
     38copyright = 'Django Software Foundation and contributors' 
    3839 
    3940# The default replacements for |version| and |release|, also used in various 
    …… 
    4142# 
    4243# The short X.Y version. 
    43 version = 'SVN' 
     44version = '1.0' 
    4445# The full version, including alpha/beta/rc tags. 
    4546release = version 
    …… 
    6667 
    6768# The name of the Pygments (syntax highlighting) style to use. 
    68 pygments_style = 'sphinx' 
     69pygments_style = 'trac' 
    6970 
    7071 
    …… 
    8081# relative to this directory. They are copied after the builtin static files, 
    8182# so a file named "default.css" will overwrite the builtin "default.css". 
    82 html_static_path = [] 
     83html_static_path = ["_static"] 
    8384 
    8485# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 
    …… 
    9091html_use_smartypants = True 
    9192 
     93# HTML translator class for the builder 
     94html_translator_class = "djangodocs.DjangoHTMLTranslator" 
     95 
    9296# Content template for the index page. 
    9397#html_index = '' 
    …… 
    98102# Additional templates that should be rendered to pages, maps page names to 
    99103# template names. 
    100 #html_additional_pages = {} 
     104html_additional_pages = {} 
    101105 
    102106# If false, no module index is generated. 
    …… 
    122126# (source start file, target name, title, author, document class [howto/manual]). 
    123127#latex_documents = [] 
     128latex_documents = [ 
     129  ('index', 'django.tex', 'Django Documentation', 'Django Software Foundation', 'manual'), 
     130] 
    124131 
    125132# Additional stuff for the LaTeX preamble. 
    …… 
    131138# If false, no module index is generated. 
    132139#latex_use_modindex = True 
     140 
     141# For "manual" documents, if this is true, then toplevel headings are parts, 
     142# not chapters. 
     143# If this isn't set to True, the LaTex writer can only handle six levels of headers. 
     144latex_use_parts = True 
     145 

  • django/trunk/docs/index.txt

    r8333 r8506  
     1.. _index: 
     2 
    13==================== 
    2 Django Documentation 
     4Django documentation 
    35==================== 
    46 
    5 The essential documentation 
    6 =========================== 
     7.. rubric:: Everything you need to know about Django (and then some). 
    78 
    8 If you're new to Django, make sure to read the following documentation in 
    9 order.. The rest (in the "reference" section below) can be ready in any order as 
    10 you need various functionality. 
     9Getting help 
     10============ 
    1111 
    12 .. toctree:: 
    13    :maxdepth: 1 
    14     
    15    overview 
    16    install 
    17    tutorial01 
    18    tutorial02 
    19    tutorial03 
    20    tutorial04 
    21    faq 
    22    documentation 
    23     
     12Having trouble? We'd like to help! 
     13 
     14* Try the :ref:`FAQ <faq-index>` -- it's got answers to many common questions. 
     15 
     16* Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or 
     17  the :ref:`detailed table of contents <contents>`. 
     18 
     19* Search for information in the `archives of the django-users mailing list`_, or 
     20  `post a question`_ 
     21   
     22* Ask a question in the `#django IRC channel`_, or search the `IRC logs`_ to see 
     23  if its been asked before 
     24 
     25* Report bugs with Django in our `ticket tracker`_. 
     26 
     27.. _archives of the django-users mailing list: http://groups.google.com/group/django-users/ 
     28.. _post a question: http://groups.google.com/group/django-users/ 
     29.. _#django IRC channel: irc://irc.freenode.net/django 
     30.. _IRC logs: http://oebfare.com/logger/django/ 
     31.. _ticket tracker: http://code.djangoproject.com/ 
     32 
     33First steps 
     34=========== 
     35 
     36:ref:`Overview <intro-overview>` 
     37    See what writing a database-driven application with Django looks like. 
     38     
     39:ref:`Installation <intro-install>` 
     40    Get Django installed on your computer. 
     41     
     42Tutorial: Writing your first Django application 
     43=============================================== 
     44 
     45:ref:`Part 1 <intro-tutorial01>` 
     46    Get set up, create models, and play with the database API. 
     47     
     48:ref:`Part 2 <intro-tutorial02>` 
     49    Explore the automatically-generated admin site. 
     50     
     51:ref:`Part 3 <intro-tutorial03>` 
     52    Write the public interface views. 
     53     
     54:ref:`Part 4 <intro-tutorial04>` 
     55    Learn how to process forms. 
     56         
     57Using Django 
     58============ 
     59 
     60:ref:`Models <topics-db-index>` 
     61    Design a single, definitive source of data about your data. 
     62     
     63:ref:`Handling web requests <topics-http-index>` 
     64    Handle web requests, map them to views, and return pages. 
     65     
     66:ref:`Forms <topics-forms-index>` 
     67    Build and handle HTML forms. 
     68     
     69:ref:`Templates <topics-templates>` 
     70    Develop the visual design of your site. 
     71     
     72And more: 
     73--------- 
     74 
     75:ref:`topics-auth` ... :ref:`topics-cache` ... :ref:`topics-email` ... 
     76:ref:`topics-files` ... :ref:`topics-i18n` ... :ref:`topics-install` ... 
     77:ref:`topics-pagination` ... :ref:`topics-serialization` ... 
     78:ref:`topics-settings` ... :ref:`topics-testing` 
     79     
     80Add-on ("contrib") applications 
     81=============================== 
     82 
     83:ref:`Django's automatic admin site <ref-contrib-admin>` 
     84    Get a clean interface to your data with no effort at all. 
     85     
     86:ref:`Form tools <ref-contrib-formtools-index>` 
     87    Easily handle complex form workflows. 
     88     
     89:ref:`Syndication feeds <ref-contrib-syndication>` 
     90    Generate RSS and Atom feeds of your data. 
     91     
     92:ref:`"Local flavor" <ref-contrib-localflavor>` 
     93    Give your site that special local touch. 
     94     
     95And more: 
     96--------- 
     97 
     98:ref:`ref-contrib-contenttypes` ... :ref:`ref-contrib-csrf` ... 
     99:ref:`ref-contrib-databrowse` ... :ref:`ref-contrib-flatpages` ... 
     100:ref:`ref-contrib-humanize` ... :ref:`ref-contrib-redirects` ... 
     101:ref:`ref-contrib-sitemaps` ... :ref:`ref-contrib-sites` ... 
     102:ref:`ref-contrib-webdesign` 
     103 
     104Solving specific problems 
     105========================= 
     106 
     107:ref:`Deployment <howto-deployment-index>` 
     108    Release your project to the world. 
     109     
     110:ref:`Importing data from legacy databases <howto-legacy-databases>` 
     111    Use Django with an existing database or alongside other web development 
     112    toolkits. 
     113 
     114:ref:`Custom template tags <howto-custom-template-tags>` 
     115    Add your own extensions to Django's template language. 
     116     
     117:ref:`Generating CSV <howto-outputting-csv>` & :ref:`PDF <howto-outputting-PDF>` 
     118    Produce non-HTML content with Django. 
     119     
     120And more: 
     121--------- 
     122 
     123:ref:`Authenticating in Apache <howto-apache-auth>` ... 
     124:ref:`howto-custom-file-storage` ... :ref:`howto-custom-management-commands` ... 
     125:ref:`howto-custom-model-fields` ... :ref:`howto-error-reporting` ... 
     126:ref:`howto-initial-data` ... :ref:`howto-static-files` 
     127     
    24128Reference 
    25129========= 
    26130 
    27 .. toctree:: 
    28    :maxdepth: 1 
    29     
    30    django-admin 
    31    model-api 
    32    db-api 
    33    transactions 
    34    templates 
    35    templates_python 
    36    forms 
    37    modelforms 
    38    files 
    39    upload_handling 
    40    testing 
    41    sessions 
    42    cache 
    43    settings 
    44    url_dispatch 
    45    request_response 
    46    generic_views 
    47    authentication 
    48    shortcuts 
    49    unicode 
    50    pagination 
    51    serialization 
    52    i18n 
    53    middleware 
    54    custom_model_fields 
    55    databases 
    56     
    57 ``django.contrib`` add-ons 
    58 -------------------------- 
     131:ref:`Settings <ref-settings>` 
     132    See all of Django's settings and what they do. 
     133     
     134:ref:`Request & response objects <ref-request-response>` 
     135    Understand the classes Django uses to represent HTTP requests and responses. 
    59136 
    60 .. toctree:: 
    61    :maxdepth: 1 
    62     
    63    admin 
    64    add_ons 
    65    contenttypes 
    66    csrf 
    67    databrowse 
    68    flatpages 
    69    form_preview 
    70    form_wizard 
    71    localflavor 
    72    redirects 
    73    sites 
    74    sitemaps 
    75    syndication_feeds 
    76    webdesign 
    77     
    78 Deployment 
    79 ---------- 
    80  
    81 .. toctree:: 
    82    :maxdepth: 1 
    83  
    84    modpython 
    85    fastcgi 
     137:ref:`Model API reference <ref-models-index>` 
     138    Revel in the gory details of Django's model system. 
     139         
     140:ref:`Form API reference <ref-forms-index>` 
     141    Learn the details of forms, fields, and widgets. 
    86142     
    87 Solving specific problems 
    88 ------------------------- 
    89  
    90 .. toctree:: 
    91    :maxdepth: 1 
    92  
    93    apache_auth 
    94    static_files 
    95    email 
    96    legacy_databases 
    97    outputting_pdf 
    98    outputting_csv 
    99      
    100 Et cetera 
     143And more: 
    101144--------- 
    102145 
    103 .. toctree:: 
    104    :maxdepth: 1 
     146:ref:`ref-databases` ... :ref:`ref-django-admin` ... :ref:`ref-files-index` ... 
     147:ref:`ref-generic-views` ... :ref:`ref-middleware` ... 
     148:ref:`ref-templates-index` ... :ref:`ref-unicode` 
     149     
     150And all the rest 
     151================ 
    105152 
    106    design_philosophies 
    107    contributing 
    108    admin_css 
    109    api_stability 
    110    distributions 
     153:ref:`Internals <internals-index>` 
     154    Learn how Django works under the hood, and how you can contribute to the 
     155    project. 
    111156 
    112 Release notes 
    113 ------------- 
     157:ref:`Release notes <releases-index>` 
     158    See what is and was new in each release of Django. 
    114159 
    115 .. toctree:: 
    116    :maxdepth: 1 
    117  
    118    release_notes_0.96 
    119    release_notes_0.95 
    120    release_notes_1.0_alpha 
    121    release_notes_1.0_alpha_2 
    122  
    123 Also see the list of `backwards-incompatible changes`__ for changes made between 
    124 releases. 
    125  
    126 __ http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges 
    127  
    128 Indices and tables 
    129 ================== 
    130  
    131 * :ref:`genindex` 
    132 * :ref:`modindex` 
    133 * :ref:`search` 
    134  
     160:ref:`Miscellany <misc-index>` 
     161    Stuff we can't find a more organized place for. Like that drawer in your 
     162    kitchen with the scissors, batteries, and duct tape. 

  • django/trunk/docs/Makefile

    r7370 r8506  
    1212ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 
    1313 
    14 .PHONY: help clean html web htmlhelp latex changes linkcheck 
     14.PHONY: help clean html web pickle htmlhelp latex changes linkcheck 
    1515 
    1616help: 
    1717        @echo "Please use \`make <target>' where <target> is one of" 
    1818        @echo "  html      to make standalone HTML files" 
    19         @echo "  web       to make files usable by Sphinx.web" 
     19        @echo "  pickle    to make pickle files (usable by e.g. sphinx-web)" 
    2020        @echo "  htmlhelp  to make HTML files and a HTML help project" 
    2121        @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 
    …… 
    3232        @echo "Build finished. The HTML pages are in _build/html." 
    3333 
    34 web: 
    35         mkdir -p _build/web _build/doctrees 
    36         $(SPHINXBUILD) -b web $(ALLSPHINXOPTS) _build/web 
     34pickle: 
     35        mkdir -p _build/pickle _build/doctrees 
     36        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle 
    3737        @echo 
    38         @echo "Build finished; now you can run" 
    39         @echo "  python -m sphinx.web _build/web" 
    40         @echo "to start the server." 
     38        @echo "Build finished; now you can process the pickle files or run" 
     39        @echo "  sphinx-web _build/pickle" 
     40        @echo "to start the sphinx-web server." 
     41 
     42web: pickle 
    4143 
    4244htmlhelp: 

  • django/trunk/docs/man/django-admin.1

    r8234 r8506  
    160160.TP 
    161161.I \-a, \-\-all 
    162 Process all available locales when using makemessages. 
    163 .SH "ENVIRONMENT" 
     162Process all available locales when using makemessages..SH "ENVIRONMENT" 
    164163.TP 
    165164.I DJANGO_SETTINGS_MODULE