mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-25 02:26:12 +00:00
Code Issues 25 Releases Wiki Activity
d2ad3b0f96
django/docs
History
Aymeric Augustin d2ad3b0f96 Clarified the purpose of the pull requsets docs 
One is for the community, the other for the core team.

Thanks Reinout van Rees for the report.
2012-06-08 11:53:54 +02:00
..
_ext Made more extensive usage of context managers with open. 2012-05-05 14:06:36 +02:00
_theme/djangodocs
faq Removed references to changes made in 1.2. 2012-06-07 15:02:35 +02:00
howto Removed references to changes made in 1.2. 2012-06-07 15:02:35 +02:00
internals Clarified the purpose of the pull requsets docs 2012-06-08 11:53:54 +02:00
intro Fixed #17933 -- Added a missing label to the docs. 2012-06-07 19:47:32 +02:00
man Fixed #18035 -- Removed deprecated AdminMediaHandler, as per official deprecation timeline. Thanks Jannis Leidel and Ramiro Morales for the review. 2012-04-08 21:13:32 +00:00
misc Fixed #18033 -- Removed function-based generic views, as per official deprecation timeline. Rest in peace! Thanks Anssi Kääriäinen for the review. 2012-04-25 19:17:47 +00:00
obsolete
ref Fixed #18445 -- Added a links in the docs. 2012-06-07 22:11:24 +02:00
releases Proof-read the new contributing guide. 2012-06-08 11:26:22 +02:00
topics Fixed #18125 -- Explained caveat with filters 2012-06-08 10:25:42 +02:00
conf.py Fixed #18269 -- Applied unicode_literals for Python 3 compatibility. 2012-06-07 18:08:47 +02:00
contents.txt
glossary.txt Fixed #18033 -- Removed function-based generic views, as per official deprecation timeline. Rest in peace! Thanks Anssi Kääriäinen for the review. 2012-04-25 19:17:47 +00:00
index.txt Fixed #18436 -- Updated contributing docs for git. 2012-06-07 18:54:43 +02:00
make.bat Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
Makefile Added gettext target to sphinx makefiles. 2012-04-07 22:35:57 +00:00
README Fixed #9995 -- Updated the installation instructions to recommend pip. Also fixed ReST errors. Refs #9112. 2012-03-03 09:11:54 +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:

* 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/