mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-11 14:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Simon Charette a304e7ddff [1.9.x] Fixed #26438 -- Fixed multiple .objects typos in the docs. 
Thanks Pablo Oubiña for the report.

Backport of 64aba7a8ab from master
2016-03-31 18:30:58 -04:00
..
_ext [1.9.x] Fixed #23868 -- Added support for non-unique django-admin-options in docs. 2016-02-01 11:25:42 -05:00
_theme [1.9.x] Fixed many spelling mistakes in code, comments, and docs. 2015-12-03 12:49:03 -05:00
faq [1.9.x] Changed gypsy to manouche in docs and tests. 2016-02-03 09:48:01 -05:00
howto [1.9.x] Fixed #26436 -- Added a link to the settings filtering in the error reporting howto. 2016-03-31 13:46:40 -04:00
internals [1.9.x] Fixed a broken link in docs/internals/contributing/writing-documentation.txt. 2016-03-19 16:19:51 -04:00
intro [1.9.x] Fixed #26416 -- Fixed references to previous tutorial numbers in docs/intro/reusable-apps.txt. 2016-03-28 18:31:16 -04:00
man [1.9.x] Discouraged use of /tmp with predictable names. 2015-12-24 09:56:54 -05:00
misc [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
ref [1.9.x] Removed some docs that should have been removed along with PROFANITIES_LIST. 2016-03-31 13:23:29 -04:00
releases [1.9.x] Fixed #26384 -- Fixed renaming the PK on a model with a self-referential FK on SQLite. 2016-03-29 13:26:59 -04:00
topics [1.9.x] Fixed #26438 -- Fixed multiple .objects typos in the docs. 2016-03-31 18:30:58 -04:00
conf.py [1.9.x] Fixed possible "RuntimeError: maximum recursion depth exceeded" building docs. 2016-02-16 07:31:26 -05:00
contents.txt [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
glossary.txt [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
index.txt [1.9.x] Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:18:24 -05:00
make.bat
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.9.x] Fixed #26267 -- Fixed BoundField to reallow slices of subwidgets. 2016-02-24 07:03:24 -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/