django

mirror of https://github.com/django/django.git synced 2024-11-18 23:44:22 +00:00

History

Alex Gaynor 19e1a3556f Fix a reST foul up. git-svn-id: http://code.djangoproject.com/svn/django/trunk@17533 bcc190cf-cafb-0310-a4f2-bffc1f526a37		2012-02-16 04:32:42 +00:00
..
_ext	Fixed #17526 - unnecessary comma in 'Please, see the release notes' removed	2012-01-11 10:19:05 +00:00
_theme/djangodocs
faq	Fixed #17129 - Model FAQ: Link to south	2011-11-01 22:27:02 +00:00
howto	Fixed #17625 -- Mention in the management command docs that modules with an underscore prefix are ignored and not dissplayed in the list of commands.	2012-02-04 18:27:14 +00:00
internals	Updated my bio.	2012-01-25 16:43:52 +00:00
intro	Made a bunch more edits up until [17418]	2012-02-03 20:45:45 +00:00
man	Fixed a couple of minor errors in the django-admin(1) Unix man page.	2012-02-06 02:00:19 +00:00
misc	Fixed many more ReST indentation errors, somehow accidentally missed from [16955]	2011-10-14 00:12:01 +00:00
obsolete
ref	Fixed #17693 . Input validation and tests for base36 conversion utils. Thanks Keryn Knight for the report.	2012-02-16 00:58:49 +00:00
releases	Fix a reST foul up.	2012-02-16 04:32:42 +00:00
topics	Fixed #17652 -- Removed all mentions to Windmill from the docs as that project doesn't integrate well with Django at this time.	2012-02-15 17:33:51 +00:00
conf.py	Bump version numbers for 1.4 beta 1.	2012-02-16 02:12:20 +00:00
contents.txt
glossary.txt	Converted links to external topics so they use intersphinx extension markup.	2011-09-04 21:17:30 +00:00
index.txt	Fixed #16277 -- Changed the link to the IRC logs.	2011-11-25 19:40:46 +00:00
make.bat	Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin.	2011-07-19 09:00:24 +00:00
Makefile
README	Fixed #16414 -- Added standard Windows make batch file for Sphinx. Thanks, Aymeric Augustin.	2011-07-19 09:00:24 +00:00

README

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

Technically speaking, 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 on a Unix machine (Linux or Mac):

* Install Sphinx (using ``easy_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/