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
514104cf23
django/docs
History
GwynBleidD 5402061c80 Refs #30062 -- Corrected UniqueConstraint signature in docs.
2019-05-20 10:52:57 +02:00
..
_ext
_theme
faq Used extlinks for Django's source code. 2019-03-28 20:32:17 -04:00
howto Changed poll_id to poll_ids in examples of custom management commands. 2019-05-20 10:11:38 +02:00
internals Fixed #30220 -- Added support for headless mode in selenium tests. 2019-05-17 08:14:54 +02:00
intro Fixed #30399 -- Changed django.utils.html.escape()/urlize() to use html.escape()/unescape(). 2019-04-25 15:09:07 +02:00
man Updated man page for 2.2 final. 2019-04-01 12:04:08 +02:00
misc
ref Refs #30062 -- Corrected UniqueConstraint signature in docs. 2019-05-20 10:52:57 +02:00
releases Fixed #30488 -- Removed redundant Coalesce call in SQL generated by SearchVector. 2019-05-20 08:34:06 +02:00
topics Changed docs to link to Python's description of iterable. 2019-05-17 17:27:19 +02:00
conf.py Moved extlinks in docs config to allow using 'version' variable. 2019-03-28 20:47:51 -04:00
contents.txt
glossary.txt
index.txt Removed dead links to botbot.me. 2018-11-10 17:25:10 -05:00
make.bat
Makefile
README Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00
spelling_wordlist Removed unused words from docs/spelling_wordlist. 2019-02-02 15:36:20 +01: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 ``python -m 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/