mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-24 13:44:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Tim Graham 59ea6fd686 [1.10.x] Fixed #27511 -- Corrected Field.related_model docs about GenericRelation. 
Backport of 55adfc0760 from master
2016-11-21 12:53:35 -05:00
..
_ext [1.10.x] Added a CVE role for Sphinx. 2016-09-26 18:22:14 -04:00
_theme Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:48:24 -05:00
faq [1.10.x] Replaced "django" with "Django" in spelling_wordlist. 2016-11-15 17:32:16 -05:00
howto [1.10.x] Replaced "django" with "Django" in spelling_wordlist. 2016-11-15 17:32:16 -05:00
internals [1.10.x] Refs #23811 -- Corrected git bisect run example usage. 2016-11-21 06:55:31 -05:00
intro [1.10.x] Updated "fork Django on GitHub" link. 2016-11-04 05:48:54 +01:00
man [1.10.x] Updated man page for Django 1.10 alpha. 2016-05-20 06:49:36 -04:00
misc Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
ref [1.10.x] Fixed #27511 -- Corrected Field.related_model docs about GenericRelation. 2016-11-21 12:53:35 -05:00
releases [1.10.x] Fixed #27407 -- Made Model.delete(keep_parents=True) preserve parent reverse relationships. 2016-11-15 20:50:41 -05:00
topics [1.10.x] Fixed #27494 -- Fixed typos in docs/topics/db/models.txt. 2016-11-16 07:28:51 -05:00
conf.py [1.10.x] Added a CVE role for Sphinx. 2016-09-26 18:22:14 -04:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Refs #3254 -- Added full text search to contrib.postgres. 2016-04-22 10:44:37 +01:00
make.bat Fixed #19516 - Fixed remaining broken links. 2013-01-02 18:32:57 -05:00
Makefile Added an "htmlview" target to open docs after building them. 2014-12-08 07:23:34 -05:00
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist [1.10.x] Replaced "django" with "Django" in spelling_wordlist. 2016-11-15 17:32:16 -05: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 ``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/