django

mirror of https://github.com/django/django.git synced 2024-12-26 02:56:25 +00:00

History

Mariusz Felisiak e6588aa4e7 Added stub release notes for 2.2.1.		2019-04-03 08:26:05 +02:00
..
_ext	Fixed crash building translated docs since Sphinx 1.8.	2018-10-01 20:44:02 -04:00
_theme
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	Fixed #30265 -- Fixed a tutorial number in Reusable App tutorial.	2019-03-29 21:53:03 -04:00
man	Updated man page for 2.2 final.	2019-04-01 12:04:08 +02:00
misc
ref	Fixed typo in docs/ref/settings.txt.	2019-04-02 09:10:11 +02:00
releases	Added stub release notes for 2.2.1.	2019-04-03 08:26:05 +02:00
topics	Removed unnecessary /static from links to PostgreSQL docs.	2019-03-29 21:49:44 -04: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

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/