1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
Tim Graham e48a5b5a03 Fixed #23751 -- Fixed code snippet formatting in docs PDF.
Thanks Graham Wideman for the patch.
2015-11-16 18:49:31 -05:00
..
_ext Fixed #23751 -- Fixed code snippet formatting in docs PDF. 2015-11-16 18:49:31 -05:00
_theme Made doc icon's edges smooth. 2015-11-14 08:11:47 -05:00
faq Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
howto Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
internals Corrected outdated information in submitting patches guide. 2015-11-16 09:59:56 -05:00
intro Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
man Fixed #25578 -- Corrected the casing of "GitHub". 2015-10-21 07:31:11 -04:00
misc Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
ref Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
releases Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
topics Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
conf.py Bumped version; master is now 1.10 pre-alpha. 2015-09-23 19:31:08 -04:00
contents.txt
glossary.txt Updated Wikipedia links to use https 2015-08-08 12:02:32 +02:00
index.txt Changed section title from "Model syntax" to "Introduction to models". 2015-11-16 09:53:57 -05:00
make.bat
Makefile
README
spelling_wordlist Added "subpath" to spelling wordlist. 2015-10-22 15:01:33 -04:00

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/