django

mirror of https://github.com/django/django.git synced 2025-07-31 00:54:37 +00:00

History

Katie McLaughlin 1f304ebdc6 [2.2.x] Fixed #30767 -- Improved references to deployment documentation. * Increased tocdepth to expose more complexity of topics. * Ensured deployment checklist is linked on main doc page. Backport of `fee75d2aed` from master.		2019-09-09 10:06:58 +02:00
..
_ext
_theme
faq
howto	[2.2.x] Fixed #30767 -- Improved references to deployment documentation.	2019-09-09 10:06:58 +02:00
internals	[2.2.x] Fixed typo in docs/internals/contributing/writing-documentation.txt.	2019-09-05 14:09:02 +02:00
intro	[2.2.x] Changed example git clone URLs to use HTTPS.	2019-09-04 08:12:36 +02:00
man	[2.2.x] Updated man page for Django 2.2.	2019-09-02 08:00:01 +02:00
misc
ref	[2.2.x] Fixed #30738 -- Fixed typo in docs/ref/forms/widgets.txt.	2019-08-31 10:59:41 +02:00
releases	[2.2.x] Added stub release notes for 2.2.6.	2019-09-04 08:06:12 +02:00
topics	[2.2.x] Fixed broken links and redirects in documentation.	2019-08-21 10:58:05 +02:00
conf.py
contents.txt
glossary.txt
index.txt	[2.2.x] Fixed #30767 -- Improved references to deployment documentation.	2019-09-09 10:06:58 +02:00
make.bat
Makefile
README
spelling_wordlist

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/