mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-04-24 09:14:39 +00:00
Code Issues32 Releases Wiki Activity
d49c42e20e
django/docs
History
Erik Romijn d49c42e20e [1.7.x] Fixed -- Clarified password reset behavior in auth docs 
Backport of c5132382f081bd1b5a3618bbf23fa0cf720af14b from master.
2014-11-15 17:44:29 +01:00
..
_ext
[1.7.x] Added sphinx extension to ease generation of ticket links.
2014-08-19 17:45:59 -04:00
_theme
[1.7.x] Removed duplicate "Deprecated in Django A.B" text in docs.
2014-06-07 07:25:02 -04:00
faq
[1.7.x] Fixed -- Updated FAQs per Aymeric's suggestions.
2014-08-12 13:48:21 -04:00
howto
[1.7.x] Fixed versionchanged indentation in docs/.
2014-11-03 21:43:21 -05:00
internals
[1.7.x] Fixed versionchanged indentation in unit-tests.txt.
2014-10-23 08:04:17 -04:00
intro
[1.7.x] Fixed -- Added a link in tutorial for list_display options.
2014-11-13 20:16:29 +01:00
man
Removed a man page for a command that was removed
2014-01-10 15:23:06 -08:00
misc
Fixed -- Documented some of the design decisions of the cache framework.
2014-01-16 21:13:08 -05:00
ref
[1.7.x] Fixed -- Noted precedence of settings.USE_L10N in MONTH_DAY_FORMAT and YEAR_MONTH.
2014-11-15 09:55:31 +01:00
releases
[1.7.x] Fixed -- Typos in 1.7 release notes.
2014-11-13 20:10:40 +01:00
topics
[1.7.x] Fixed -- Clarified password reset behavior in auth docs
2014-11-15 17:44:29 +01:00
conf.py
[1.7.x] Removed simplejson inventory file from docs/conf.py.
2014-10-25 08:21:49 -04:00
contents.txt
Removed an obsolete documentation page about admin style customization.
2012-09-10 17:19:35 -07:00
glossary.txt
[1.7.x] Fixed some intersphinx references.
2014-10-16 20:02:23 -04:00
index.txt
[1.7.x] Fixed -- Refactored lookup API documentation.
2014-07-08 20:13:24 -04:00
make.bat
Fixed - Fixed remaining broken links.
2013-01-02 18:32:57 -05:00
Makefile
Fixed -- Added a spelling checker for documentation.
2014-03-07 09:29:23 -05:00
README
Whitespace cleanup.
2013-10-10 16:49:20 -04:00
spelling_wordlist
[1.7.x] Fixed -- Added a more basic explanations of forms.
2014-06-24 14:58:53 -04:00

README 

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
This allows it to be built into other forms for easier viewing and browsing.

To create an HTML version of the docs:

* Install Sphinx (using ``sudo pip install Sphinx`` or some other method)

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) at a shell prompt.

The documentation in _build/html/index.html can then be viewed in a web browser.

[1] http://docutils.sourceforge.net/rst.html
[2] http://sphinx-doc.org/