django

mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00

History

Katie McLaughlin f52022ad96 Made minor edits and small fixes to docs/faq/install.txt.		2019-10-04 11:21:50 +02:00
..
_ext
_theme
faq	Made minor edits and small fixes to docs/faq/install.txt.	2019-10-04 11:21:50 +02:00
howto	Fixed some typos in comments and docs.	2019-10-02 15:50:46 +02:00
internals	Refs #30010 -- Doc'd running tests with django-docker-box.	2019-10-02 13:43:47 +02:00
intro	Fixed some typos in comments and docs.	2019-10-02 15:50:46 +02:00
man	Updated man page for 3.0 alpha release.	2019-09-10 10:10:50 +02:00
misc
ref	Fixed #30834 -- Added explicit list of supported databases to the databases docs.	2019-10-03 19:34:51 +02:00
releases	Refs #14218 -- Adjusted release note to use present tense.	2019-10-03 10:14:06 +02:00
topics	Fixed #30597 -- Clarified how to unapply migrations.	2019-09-27 21:25:27 +02: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

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/