django

mirror of https://github.com/django/django.git synced 2024-12-23 17:46:27 +00:00

History

Tim Graham cf1fe22009 Fixed typos in docs/ref/models/constraints.txt.		2019-01-10 18:52:42 -05: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	Renamed Sqlite and Sqlite3 references to SQLite.	2018-12-22 18:52:54 -05:00
howto	Fixed broken links to PyYAML page.	2018-12-27 10:48:37 +01:00
internals	Fixed #30037 -- Added request arg to RemoteUserBackend.configure_user().	2019-01-09 20:01:04 -05:00
intro	Used auto-numbered lists in documentation.	2018-11-15 13:54:28 -05:00
man	Updated man page for Django 2.1 alpha.	2018-05-17 09:30:20 -04:00
misc
ref	Fixed typos in docs/ref/models/constraints.txt.	2019-01-10 18:52:42 -05:00
releases	Refs #28643 -- Added NullIf database function.	2019-01-10 12:10:12 -05:00
topics	Followed style guide for model attribute ordering.	2018-12-27 19:34:14 -05:00
conf.py	Removed obsolete html_use_smartypants Sphinx option.	2018-09-18 11:51:04 -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	Fixed #28990 -- Added autosummarize parameter to BrinIndex.	2018-08-02 11:26:58 -04: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/