1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
2019-11-21 10:54:05 +01:00
..
_ext Made versionadded/versionchanged annotations without a content end with ".". 2019-11-21 09:03:18 +01:00
_theme
faq Refs #29926 -- Doc'd Python 3.8 compatibility in Django 2.2.x. 2019-11-12 22:11:44 +01:00
howto Fixed #30999 -- Fixed typo in docs/howto/custom-template-tags.txt. 2019-11-19 10:08:32 +01:00
internals Pinned asgiref version. 2019-11-20 14:57:08 +01:00
intro Fixed #29983 -- Replaced os.path() with pathlib.Path in project template and docs. 2019-11-07 11:11:27 +01:00
man Updated man page for 3.0 alpha release. 2019-09-10 10:10:50 +02:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Fixed #25388 -- Added an option to allow disabling of migrations during test database creation. 2019-11-20 20:42:38 +01:00
releases Fixed #30625 -- Doc'd cache.get()/delete() behavior change in Django 2.2. 2019-11-21 10:54:05 +01:00
topics Fixed #31008 -- Fixed typos in docs/topics/logging.txt. 2019-11-20 20:35:36 +01:00
conf.py Bumped version; master is now 3.1 pre-alpha. 2019-09-10 11:54:25 +02:00
contents.txt
glossary.txt
index.txt Fixed #30767 -- Improved references to deployment documentation. 2019-09-09 10:02:33 +02:00
make.bat
Makefile
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

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/