p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
django/docs
History
Tim Graham ab38f4b27b [1.10.x] Fixed #27988 -- Fixed typo in docs/ref/django-admin.txt. 
Backport of ea36e7454c from master
 		2017-03-28 10:38:36 -04:00
..
_ext [1.10.x] Fixed missing versionadded/changed annotations on docs.djangoproject.com. 2016-12-14 14:46:14 -05: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] Fixed typo in docs/howto/custom-template-tags.txt. 2017-03-01 15:43:03 -05:00
internals [1.10.x] Refs #24154 -- Added check_aggregate_support() to deprecation timeline. 2016-12-31 14:06:18 -05:00
intro [1.10.x] Clarified that creating a pull request for the tutorial isn't necessary. 2017-02-16 11:34:28 -05: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 #27988 -- Fixed typo in docs/ref/django-admin.txt. 2017-03-28 10:38:36 -04:00
releases [1.10.x] Fixed #27981 -- Doc'd date/time filter l10n changes in refs #25758. 2017-03-27 12:53:33 -04:00
topics [1.10.x] Removed unexpected initial attribute in data migration examples. 2017-03-25 16:00:20 -04: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
conf.py [1.10.x] Removed deprecated html_translator_class sphinx config option. 2016-12-08 13:20:54 -05: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
spelling_wordlist [1.10.x] Fixed #27439 -- Documented macOS locale configuration for Django tests. 2016-12-20 13:21:18 -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/