p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
django/docs
History
Hasan Ramezani fb260ad777 [3.0.x] Corrected some typos in documentation. 
Backport of 70d95682b1 from master
 		2019-12-18 11:37:32 +01:00
..
_ext [3.0.x] Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+. 2019-11-25 10:34:21 +01:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq [3.0.x] Fixed #31018 -- Removed django-nonrel in NoSQL databases FAQ. 2019-11-27 07:37:32 +01:00
howto [3.0.x] Updated Pytest example in upgrade documentation. 2019-12-18 10:43:36 +01:00
internals [3.0.x] Fixed typo in internals/contributing/writing-documentation.txt. 2019-12-03 21:04:23 +01:00
intro [3.0.x] Fixed #31062 -- Doc'd asgi.py in tutorials and project templates. 2019-12-05 08:40:19 +01:00
man [3.0.x] Updated man page for Django 3.0 release candidate 1. 2019-11-18 09:27:41 +01:00
misc [3.0.x] Expanded API stability docs to include our policy of continual improvement. 2019-11-18 21:39:30 +01:00
ref [3.0.x] Doc'd HttpResponse.set_cookie()'s secure argument. 2019-12-13 11:06:47 +01:00
releases [3.0.x] Added stub release notes for 3.0.2. 2019-12-18 10:52:37 +01:00
topics [3.0.x] Corrected some typos in documentation. 2019-12-18 11:37:32 +01: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
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 [3.0.x] Refs #30451 -- Doc'd asynchronous support and async-safety. 2019-12-03 17:50:18 +01:00
make.bat
…
spelling_wordlist [3.0.x] Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable. 2019-12-03 17:50:24 +01: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/