mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00
Code Issues 24 Releases Wiki Activity
06ba4b9eee
django/docs
History
africa itcase 06ba4b9eee Fixed typo in docs/ref/contrib/admin/index.txt.
2014-07-22 13:27:27 -04:00
..
_ext Removed duplicate "Deprecated in Django A.B" text in docs. 2014-06-06 20:31:23 -04:00
_theme Made docs CSS for versionchanged/added more similar to docs.djangoproject.com. 2014-06-30 18:38:30 -04:00
faq Fixed #22880 -- Added FAQ entry about UnicodeDecodeError 2014-06-24 09:02:28 +02:00
howto Fixed #22809 -- Added model Field API reference. 2014-07-10 06:03:04 -04:00
internals Replaced instances of 'his/her' with 'their'. 2014-07-21 19:49:12 +00:00
intro Edited setup.py in reuseable apps tutorial to use a context manager for open(). 2014-07-16 14:21:27 -04:00
man Completed long overdue sqlinitialdata deprecation. 2014-05-11 23:15:59 -03:00
misc
ref Fixed typo in docs/ref/contrib/admin/index.txt. 2014-07-22 13:27:27 -04:00
releases Fixed #23028: Added unique_togther support to inspectdb. 2014-07-18 16:10:59 +00:00
topics Replaced instances of 'his/her' with 'their'. 2014-07-21 19:49:12 +00:00
conf.py Fixed #17238 -- Added source code links to docs using sphinx.ext.viewcode. 2014-06-07 08:54:54 -04:00
contents.txt
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Fixed #22812 -- Refactored lookup API documentation. 2014-07-08 20:05:49 -04:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist Fixed #22796 -- Added a more basic explanations of forms. 2014-06-24 14:55:22 -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/