Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Simon Charette 810f18c2df [3.0.x] Fixed #31423 -- Clarified nested atomic() example. 
Backport of fa5e7e46d875d4143510944f19d79df7b1739bab from master
2020-04-06 06:17:16 +02:00
..
_ext
[3.0.x] Prevented (and corrected) single backtick usage in docs.
2020-04-01 15:15:21 +02:00
_theme
Refs #20910 -- Replaced snippet directive with code-block.
2018-09-10 13:00:34 -04:00
faq
[3.0.x] Prevented (and corrected) single backtick usage in docs.
2020-04-01 15:15:21 +02:00
howto
[3.0.x] Prevented (and corrected) single backtick usage in docs.
2020-04-01 15:15:21 +02:00
internals
[3.0.x] Prevented (and corrected) single backtick usage in docs.
2020-04-01 15:15:21 +02:00
intro
[3.0.x] Fixed #31385 -- Improved wording in tutorial 1.
2020-03-24 07:12:59 +01:00
man
[3.0.x] Updated man page for Django 3.0 release candidate 1.
2019-11-18 09:27:41 +01:00
misc
[3.0.x] Expanded API stability docs to include our policy of continual improvement.
2019-11-18 21:39:30 +01:00
ref
[3.0.x] Corrected docs spelling of PgBouncer.
2020-04-01 15:15:21 +02:00
releases
[3.0.x] Corrected docs spelling of PgBouncer.
2020-04-01 15:15:21 +02:00
topics
[3.0.x] Fixed #31423 -- Clarified nested atomic() example.
2020-04-06 06:17:16 +02:00
conf.py
[3.0.x] Prevented (and corrected) single backtick usage in docs.
2020-04-01 15:15:21 +02:00
contents.txt
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
glossary.txt
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
index.txt
[3.0.x] Rewrote Get Help FAQ.
2020-03-26 10:25:24 +01:00
make.bat
Fixed #19516 - Fixed remaining broken links.
2013-01-02 18:32:57 -05:00
Makefile
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
README
[3.0.x] Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:06:23 +01:00
spelling_wordlist
[3.0.x] Corrected docs spelling of PgBouncer.
2020-04-01 15:15:21 +02: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] https://www.sphinx-doc.org/