mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-25 10:35:48 +00:00
Code Issues 25 Releases Wiki Activity
4224ecb74e
django/docs
History
Tim Graham 4224ecb74e Fixed #27949 -- Doc'd how OpenLayers 3 widgets work.
2017-03-21 10:50:48 -04:00
..
_ext Refs #23919 -- Replaced super(ClassName, self) with super() in docs. 2017-01-25 11:53:05 -05:00
_theme
faq Removed an obsolete temporal reference in docs/faq/general.txt. 2017-03-21 08:20:54 -04:00
howto Fixed typo in docs/howto/custom-template-tags.txt. 2017-03-01 15:42:00 -05:00
internals Fixed #27963 -- Removed unneeded docstring example in contributing docs. 2017-03-21 10:12:41 -04:00
intro Used "0" ip shortcut for runserver example. 2017-02-21 19:13:00 -05:00
man
misc
ref Refs #27919 -- Changed Widget.get_context() attrs kwarg to an arg. 2017-03-21 09:14:45 -04:00
releases Fixed #27949 -- Doc'd how OpenLayers 3 widgets work. 2017-03-21 10:50:48 -04:00
topics Removed extra characters in docs header underlines. 2017-03-20 18:30:32 -04:00
conf.py Refs #23919 -- Removed Python 2 notes in docs. 2017-01-18 11:51:29 -05:00
contents.txt
glossary.txt
index.txt Replaced docs/internals/team.txt with DSF teams page. 2017-03-14 16:36:44 -04:00
make.bat
Makefile
README
spelling_wordlist Removed unused words from docs/spelling_wordlist. 2017-03-16 14:23:33 -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/