mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
Code Issues 25 Releases Wiki Activity
5ca290f5db
django/docs
History
Tim Graham 5ca290f5db Fixed some sphinx errors and added some links.
2013-09-06 16:15:35 -04:00
..
_ext Added a bugfix in docutils 0.11 -- docs will now build properly. 2013-07-31 09:24:29 -04:00
_theme/djangodocs
faq Fixed #19695 -- Retitle "Form Media" to "Form Assets". 2013-07-08 13:59:54 -04:00
howto Fixed #20900 -- Documented RemoteUserBackend.authenticate 2013-09-05 05:56:03 -04:00
internals Fixed instructions for running a subset of tests. 2013-09-06 14:31:27 -04:00
intro Fixed #20983 -- Updated package classifiers in reuseable apps tutorial. 2013-08-28 10:54:13 -04:00
man More migration docs, and conversion of all easy syncdb references 2013-07-25 16:19:36 +01:00
misc
ref Fixed some sphinx errors and added some links. 2013-09-06 16:15:35 -04:00
releases Fixed some sphinx errors and added some links. 2013-09-06 16:15:35 -04:00
topics Fixed #20646 -- Clarified the use of AbstractBaseUser.REQUIRED_FIELDS 2013-09-06 16:01:29 -04:00
conf.py Master is now pre-1.7. 2013-06-28 08:56:45 -05:00
contents.txt
glossary.txt
index.txt Consolidated documentation for F() and Q() 2013-09-06 12:57:25 -05:00
make.bat
Makefile Allowed overriding variables in docs/Makefile. 2013-07-29 06:51:54 -04:00
README

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 ``sudo 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.pocoo.org/