django/docs
Carlton Gibson adfd920cc5 Moved "Sign the CLA" to the bottom of New Contributor First Steps.
As discussed on the mailing list, step 1 of First Steps shouldn't be
"Find a printer".

https://groups.google.com/d/topic/django-developers/owOqFmxufgs/discussion
2019-10-15 14:10:35 +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 #30858 -- Clarified that AdminEmailHandler processes all 5xx responses. 2019-10-09 10:13:11 +02:00
internals Moved "Sign the CLA" to the bottom of New Contributor First Steps. 2019-10-15 14:10:35 +02:00
intro Fixed #30816 -- Doc'd how to create projects with a local copy of Django. 2019-10-15 12:38:40 +02:00
man Updated man page for 3.0 alpha release. 2019-09-10 10:10:50 +02:00
misc
ref Clarified that SECURE_REDIRECT_EXEMPT patterns should not include leading slashes. 2019-10-11 15:30:33 +02:00
releases Fixed #30870 -- Fixed showing that RunPython operations are irreversible by migrate --plan. 2019-10-14 11:13:27 +02:00
topics Refs #26207 -- Removed obsolete note about slow constructing a model with deferred fields. 2019-10-14 12:51:07 +02:00
Makefile
README
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
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/