mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-04-07 15:06:47 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Claude Paroz e9950ed897 [2.1.x] Fixed utils.html.escape()'s docs with regards to string coercion. 
As of 301de774c21d055e9e5a7073e5bffdb52bc71079.
Backport of 1ed8527e3df930ae54ef237e77f1a53faa0ff5ed from master
2018-07-18 14:20:17 -04:00
..
_ext
Bumped minimum Sphinx version to 1.6.0.
2018-03-22 20:30:03 -04:00
_theme
Fixed #28343 -- Add an OS chooser for docs command line examples.
2018-01-20 12:38:48 -05:00
faq
[2.1.x] Refs #28814 -- Documented Python 3.7 compatibility.
2018-06-28 11:05:32 -04:00
howto
[2.1.x] Corrected typo in outputting-csv.txt.
2018-06-01 14:42:06 +02:00
internals
[2.1.x] Removed duplicate words in docs.
2018-07-18 11:27:17 -04:00
intro
[2.1.x] Added help for common 404 error in tutorial 1.
2018-05-21 13:14:19 -04:00
man
Updated man page for Django 2.1 alpha.
2018-05-17 09:30:20 -04:00
misc
Updated various links in docs to avoid redirects
2017-05-22 19:28:44 +02:00
ref
[2.1.x] Fixed utils.html.escape()'s docs with regards to string coercion.
2018-07-18 14:20:17 -04:00
releases
[2.1.x] Removed duplicate words in docs.
2018-07-18 11:27:17 -04:00
topics
[2.1.x] Removed duplicate words in docs.
2018-07-18 11:27:17 -04:00
conf.py
[2.1.x] Bumped django_next_version in sphinx config to 2.2.
2018-05-17 20:49:30 -04: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
Fixed #28594 -- Removed Jython docs and specific code
2017-12-23 10:26:32 +01:00
make.bat
Fixed #19516 - Fixed remaining broken links.
2013-01-02 18:32:57 -05:00
Makefile
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
README
Removed sudo from pip commands in docs.
2014-09-22 15:49:48 -04:00
spelling_wordlist
Fixed #29360 -- Removed Fabric examples in docs.
2018-04-29 22:12:40 -04: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 ``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/