0
0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
django/docs
Daniel Musketa 6fd9c9daa6 Fixed #30365 -- Fixed syntax highlighting in SQL examples.
Sphinx interprets some "%[a-z]" in SQL statements as a
"Literal.String.Interpol" which leads to incorrect highlighting.
2019-04-23 12:37:50 +02:00
..
_ext Fixed crash building translated docs since Sphinx 1.8. 2018-10-01 20:44:02 -04:00
_theme Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
faq Used extlinks for Django's source code. 2019-03-28 20:32:17 -04:00
howto Fixed #30365 -- Fixed syntax highlighting in SQL examples. 2019-04-23 12:37:50 +02:00
internals Fixed #30387 -- Enhanced docs CLI examples in Unit tests and Install Django on Windows. 2019-04-23 09:32:55 +02:00
intro Fixed #30387 -- Enhanced docs CLI examples in Unit tests and Install Django on Windows. 2019-04-23 09:32:55 +02:00
man Updated man page for 2.2 final. 2019-04-01 12:04:08 +02:00
misc
ref Fixed #30365 -- Fixed syntax highlighting in SQL examples. 2019-04-23 12:37:50 +02:00
releases Fixed #30385 -- Restored SearchVector(config) immutability. 2019-04-23 08:11:33 +02:00
topics Fixed #30365 -- Fixed syntax highlighting in SQL examples. 2019-04-23 12:37:50 +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

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/