1
0
mirror of https://github.com/django/django.git synced 2025-01-11 19:06:26 +00:00
django/docs
2017-04-04 10:42:06 -04:00
..
_ext
_theme
faq Removed an obsolete temporal reference in docs/faq/general.txt. 2017-03-21 08:20:54 -04:00
howto Fixed typos in docs/howto/static-files/index.txt. 2017-04-03 08:13:48 -04:00
internals Removed unused links in docs/internals/contributing/triaging-tickets.txt. 2017-03-25 13:05:48 -04:00
intro
man
misc
ref Refs #27834 -- Removed Value wrapping from StrIndex's substring param. 2017-04-03 08:39:57 -04:00
releases Fixed #27912, CVE-2017-7233 -- Fixed is_safe_url() with numeric URLs. 2017-04-04 10:42:06 -04:00
topics Fixed #28003 -- Doc'd what an auto-created OneToOneField parent_link looks like. 2017-04-01 21:21:15 -04:00
conf.py
contents.txt
glossary.txt
index.txt Replaced docs/internals/team.txt with DSF teams page. 2017-03-14 16:36:44 -04:00
make.bat
Makefile
README
spelling_wordlist Removed unused words from docs/spelling_wordlist. 2017-03-16 14:23: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/