1
0
mirror of https://github.com/django/django.git synced 2025-01-10 18:36:05 +00:00
django/docs
2016-05-27 10:31:53 -04:00
..
_ext
_theme
faq
howto Fixed #26601 -- Improved middleware per DEP 0005. 2016-05-17 07:22:22 -04:00
internals Fixed #26637 -- Removed obsolete note in docs/internals/contributing/writing-documentation.txt 2016-05-19 09:11:56 -04:00
intro Fixed #26483 -- Updated docs.python.org links to use Intersphinx. 2016-05-08 18:07:43 -04:00
man [1.10.x] Updated man page for Django 1.10 alpha. 2016-05-20 06:49:36 -04:00
misc
ref [1.10.x] Fixed typo in docs/ref/models/querysets.txt 2016-05-27 09:13:12 -04:00
releases Removed unused sections in 1.10 release notes. 2016-05-19 11:49:15 -04:00
topics [1.10.x] Fixed typo in docs/topics/forms/modelforms.txt 2016-05-27 10:31:53 -04:00
conf.py [1.10.x] Bumped django_next_version in docs config. 2016-05-20 06:50:58 -04:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README
spelling_wordlist

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/