mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
Code Issues Releases Wiki Activity
83f4e86595
django/docs
History
Tim Graham 83f4e86595 Fixed too short title underline in docs.
2014-05-25 19:26:12 -04:00
..
_ext Fixed #21869 -- Fixed docs building with Sphinx 1.2.1. 2014-01-24 08:52:43 -05:00
_theme Fixed some typos and formatting issues in docs. 2014-03-03 08:37:17 -05:00
faq Used link label in models FAQ to ease translation 2014-05-22 09:46:34 +02:00
howto Fixed #22619 -- Corrected description of os.path. 2014-05-12 18:56:34 -04:00
internals Updated some docs for the delayed deprecation of legacy table creation; refs #22340. 2014-05-07 09:04:01 -04:00
intro Reordered tutorial 1 so that the database is configured first. 2014-05-05 13:34:46 -04:00
man Completed long overdue sqlinitialdata deprecation. 2014-05-11 23:15:59 -03:00
misc Fixed #16785 -- Documented some of the design decisions of the cache framework. 2014-01-16 21:13:08 -05:00
ref Fixed typo in docs/ref/models/custom-lookups.txt. 2014-05-25 19:01:51 -04:00
releases Fixed #22510 -- Harden field removal to only None. 2014-05-24 13:10:50 +01:00
topics Fixed too short title underline in docs. 2014-05-25 19:26:12 -04:00
conf.py Updated doc links to point to Python 3 documentation 2014-04-26 16:02:53 +02:00
contents.txt
glossary.txt Fixed some typos in the documentation. 2014-03-02 17:05:57 +01:00
index.txt Added array field support for PostgreSQL. 2014-05-22 09:53:26 +01:00
make.bat
Makefile Fixed #22141 -- Added a spelling checker for documentation. 2014-03-07 09:29:23 -05:00
README
spelling_wordlist Fixed spelling mistake and added a word to the word list. 2014-05-13 09:17:04 -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/