django

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

History

Nick Pope 07daa487ae Refs #1660 -- Doc'd the LANGUAGES_BIDI setting.		2019-03-28 20:04:24 +01: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	Added stub release notes for 3.0.	2019-01-17 10:50:25 -05:00
howto	Clarified deconstruct() in Custom Model Field docs.	2019-03-12 10:12:33 -04:00
internals	Doc'd django-docs-translation and Read the Docs release steps.	2019-03-26 13:11:41 -04:00
intro	Fixed #30277 -- Fixed broken links to packaging.python.org.	2019-03-21 10:07:27 -04:00
man	Updated man page for Django 2.2 alpha.	2019-01-17 16:25:02 +01:00
misc
ref	Refs #1660 -- Doc'd the LANGUAGES_BIDI setting.	2019-03-28 20:04:24 +01:00
releases	Fixed "byte string" typo in various docs and comments.	2019-03-28 10:00:12 +01:00
topics	Fixed #29956 -- Allowed overriding an order field widget in formsets.	2019-03-21 11:51:01 +01:00
conf.py	Used extlinks for GitHub commits.	2019-02-01 21:42:48 +01: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/