mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-29 14:46:18 +01:00
Code Issues Releases Wiki Activity
52188a5ca6
django/docs
History
Tim Graham e261337eea Fixed docs typos in lines ending with a dash.
2016-10-06 11:01:20 -04:00
..
_ext Added a CVE role for Sphinx. 2016-09-26 15:48:40 -04:00
_theme
faq Added Django 1.11, 2.0 to Python version support table. 2016-08-26 17:21:46 -04:00
howto Fixed #27305 -- Removed BaseCommand.can_import_settings unused attribute 2016-10-02 20:31:56 +02:00
internals Fixed docs typos in lines ending with a dash. 2016-10-06 11:01:20 -04:00
intro Fixed #27174 -- Explained where PollsConfig comes from in tutorial 2. 2016-09-07 14:12:53 -04:00
man
misc
ref Fixed docs typos in lines ending with a dash. 2016-10-06 11:01:20 -04:00
releases Fixed docs typos in lines ending with a dash. 2016-10-06 11:01:20 -04:00
topics Refs #11078 -- Doc'd Meta inheritance in proxy models. 2016-10-04 19:53:24 -04:00
conf.py Added a CVE role for Sphinx. 2016-09-26 15:48:40 -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 "Web server/page" in docs. 2016-09-29 19:51:59 -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/