0
0
mirror of https://github.com/django/django.git synced 2024-11-28 21:43:13 +01:00
django/docs
2019-04-15 08:57:33 +02:00
..
_ext Fixed crash building translated docs since Sphinx 1.8. 2018-10-01 20:44:02 -04:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq Used extlinks for Django's source code. 2019-03-28 20:32:17 -04:00
howto Removed unnecessary /static from links to PostgreSQL docs. 2019-03-29 21:49:44 -04:00
internals Doc'd django-docs-translation and Read the Docs release steps. 2019-03-26 13:11:41 -04:00
intro Corrected wording in docs/intro/overview.txt. 2019-04-14 09:34:57 +02:00
man Updated man page for 2.2 final. 2019-04-01 12:04:08 +02:00
misc
ref Fixed #30326 -- Doc'd how to avoid persistence of F() assignment. 2019-04-15 08:57:33 +02:00
releases Fixed #30350 -- Prevented recreation of migration for operations with a range object. 2019-04-14 12:04:48 +02:00
topics Fixed #30347 -- Fixed typo in docs/topics/db/aggregation.txt. 2019-04-13 12:35:31 +02:00
conf.py Moved extlinks in docs config to allow using 'version' variable. 2019-03-28 20:47:51 -04:00
contents.txt
glossary.txt
index.txt Removed dead links to botbot.me. 2018-11-10 17:25:10 -05:00
make.bat
Makefile
README
spelling_wordlist Removed unused words from docs/spelling_wordlist. 2019-02-02 15:36:20 +01: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/