mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-04-23 00:34:37 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Adam Johnson f4b7acedbf [3.0.x] Documented admonition on when to use custom signals 
Thanks Cesar Canassa for the suggestion and Aymeric Augustin for review.
Backport of 566fca14b3e1406f918898de5bb2b2382a44edaf from master
2019-09-25 10:39:55 +01:00
..
_ext
Fixed crash building translated docs since Sphinx 1.8.
2018-10-01 20:44:02 -04:00
_theme
Refs #20910 -- Replaced snippet directive with code-block.
2018-09-10 13:00:34 -04:00
faq
Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
2019-09-06 13:27:46 +02:00
howto
Fixed #30767 -- Improved references to deployment documentation.
2019-09-09 10:02:33 +02:00
internals
[3.0.x] Expanded notes on alphas in release How-to.
2019-09-12 10:37:24 +02:00
intro
[3.0.x] Fixed #30775 -- Added admonition about missing imports to "Running tests" section in tutorial 5.
2019-09-16 10:03:51 +02:00
man
Updated man page for 3.0 alpha release.
2019-09-10 10:10:50 +02:00
misc
Updated various links in docs to avoid redirects
2017-05-22 19:28:44 +02:00
ref
[3.0.x] Refs #26601 -- Used new-style middlewares in documentation.
2019-09-24 09:59:06 +02:00
releases
[3.0.x] Fixed #30769 -- Fixed a crash when filtering against a subquery JSON/HStoreField annotation.
2019-09-16 08:53:02 +02:00
topics
[3.0.x] Documented admonition on when to use custom signals
2019-09-25 10:39:55 +01:00
conf.py
[3.0.x] Bumped next Django version in docs config.
2019-09-10 10:34:38 +02: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
Fixed #30767 -- Improved references to deployment documentation.
2019-09-09 10:02:33 +02:00
make.bat
Fixed #19516 - Fixed remaining broken links.
2013-01-02 18:32:57 -05:00
Makefile
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
README
Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints.
2019-04-18 14:41:15 +02:00
spelling_wordlist
Fixed #27910 -- Added enumeration helpers for use in Field.choices.
2019-09-04 14:42:49 +02: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 ``python -m 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/