1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
Fredrik 98188cb33d Refs #20935 -- Removed duplicate ToC references.
These sections are being referred to already from other locations. Having multiple references to the same location from the ToC is ambiguous, and causes errors in the EPUB build.
2019-12-04 11:36:40 +01:00
..
_ext Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+. 2019-11-25 10:33:33 +01:00
_theme
faq Fixed #31018 -- Removed django-nonrel in NoSQL databases FAQ. 2019-11-27 07:36:20 +01:00
howto Refs #20935 -- Removed duplicate ToC references. 2019-12-04 11:36:40 +01:00
internals Fixed typo in internals/contributing/writing-documentation.txt. 2019-12-03 20:11:54 +01:00
intro Fixed #29983 -- Replaced os.path() with pathlib.Path in project template and docs. 2019-11-07 11:11:27 +01:00
man Updated man page for 3.0 alpha release. 2019-09-10 10:10:50 +02:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Fixed #31046 -- Allowed RelatedManager.add()/create()/set() to accept callable values in through_defaults. 2019-12-03 19:47:38 +01:00
releases Fixed #31059 -- Fixed typo in docs/releases/3.0.txt. 2019-12-04 09:22:51 +01:00
topics Removed leftover word in CBV mixins docs. 2019-12-04 08:59:44 +01:00
conf.py Bumped version; master is now 3.1 pre-alpha. 2019-09-10 11:54:25 +02:00
contents.txt
glossary.txt
index.txt Refs #30451 -- Doc'd asynchronous support and async-safety. 2019-12-03 17:29:10 +01:00
make.bat
Makefile
README
spelling_wordlist Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable. 2019-12-03 17:29:31 +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/