mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00
Code Issues 24 Releases Wiki Activity
c2e94bd8df
django/docs
History
Tim Graham c2e94bd8df Fixed #27212 -- Fixed typo in docs/howto/static-files/index.txt.
2016-09-12 16:05:27 -04:00
..
_ext Added copy-to-clipboard support for all code snippets 2016-07-06 17:11:59 +02:00
_theme
faq Added Django 1.11, 2.0 to Python version support table. 2016-08-26 17:21:46 -04:00
howto Fixed #27212 -- Fixed typo in docs/howto/static-files/index.txt. 2016-09-12 16:05:27 -04:00
internals Fixed #27098 -- Deprecated DatabaseIntrospection.get_indexes 2016-09-12 09:26:33 +02:00
intro Fixed #27174 -- Explained where PollsConfig comes from in tutorial 2. 2016-09-07 14:12:53 -04:00
man
misc
ref Fixed #27209 -- Fixed typo in docs/ref/models/database-functions.txt. 2016-09-12 08:07:30 -04:00
releases Fixed #27098 -- Deprecated DatabaseIntrospection.get_indexes 2016-09-12 09:26:33 +02:00
topics Fixed #26401 -- Added BaseAuthConfig to use auth without migrations. 2016-09-10 16:38:05 -07:00
conf.py Ignored new warnings when building the docs with Sphinx 1.4. 2016-06-01 11:03:41 -04:00
contents.txt
glossary.txt
index.txt Fixed #26709 -- Added class-based indexes. 2016-06-27 10:41:01 -04:00
make.bat
Makefile
README
spelling_wordlist Normalized spelling of ETag. 2016-09-09 11:00:21 -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/