1
0
mirror of https://github.com/django/django.git synced 2024-11-18 15:34:16 +00:00
django/docs
Ramiro Morales f3a0ecc9ee Changed (again) technique to get version IDs shown in docs from source code.
Hopefully it will fix the problem with the documentation building server
that caused a wrong Django version to be reported in the HTML zipball
docs edition.

Follow-up to commits 373df56 and 0b98ef6.
2012-11-25 11:58:06 -03:00
..
_ext
_theme/djangodocs Fixed #19317 - Added an image for warning blocks in the docs 2012-11-22 06:34:15 -05:00
faq Fixed #19315 -- Improved markup in admin FAQ. 2012-11-17 23:25:52 +01:00
howto Fix typo in file storage docs. 2012-11-17 23:25:37 +01:00
internals Fixed #19291 -- Completed deprecation of ADMIN_MEDIA_PREFIX. 2012-11-17 22:38:19 +01:00
intro Fixed #16779 - Added a contributing tutorial 2012-11-17 14:10:25 -05:00
man
misc Replaced mentions of Subversion by Git in docs 2012-10-14 23:03:01 +02:00
ref Fixed #19280 -- Raised an explicit exception for the old {% url %} syntax. 2012-11-24 22:10:51 +01:00
releases Removed obsolete contrib.comments upgrade guide 2012-11-24 18:10:51 +01:00
topics Fixed #19218 -- Added documentation note on limitations of signals with custom User models. 2012-11-24 13:53:44 +08:00
conf.py Changed (again) technique to get version IDs shown in docs from source code. 2012-11-25 11:58:06 -03:00
contents.txt Removed an obsolete documentation page about admin style customization. 2012-09-10 17:19:35 -07:00
glossary.txt
index.txt Fixed #16779 - Added a contributing tutorial 2012-11-17 14:10:25 -05:00
make.bat Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
Makefile Fixed #19266 -- Added Texinfo documentation target 2012-11-09 09:00:27 +01:00
README Fixed #18928. Tightened language in docs/README. 2012-09-08 11:11:37 +05:30

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/