Andrew Godwin c90ab30fa1 Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable. 5 years ago
..
_ext 89d41cba39 Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+. 5 years ago
_theme c49ea6f591 Refs #20910 -- Replaced snippet directive with code-block. 6 years ago
faq a36f7ed6ac Fixed #31018 -- Removed django-nonrel in NoSQL databases FAQ. 5 years ago
howto 33eecfa740 Fixed #30999 -- Fixed typo in docs/howto/custom-template-tags.txt. 5 years ago
internals 42df1b178b Refs #31029 -- Added note about :rfc: role in writing documentation docs. 5 years ago
intro 26554cf5d1 Fixed #29983 -- Replaced os.path() with pathlib.Path in project template and docs. 5 years ago
man 513f137cfd Updated man page for 3.0 alpha release. 5 years ago
misc 5cef2cd4a1 Expanded API stability docs to include our policy of continual improvement. 5 years ago
ref a1f14ee3e5 Fixed #31006 -- Doc'd backslash escaping in date/time template filters. 5 years ago
releases c90ab30fa1 Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable. 5 years ago
topics c90ab30fa1 Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable. 5 years ago
Makefile f370bfb108 Fixed docs build with Sphinx 1.6. 7 years ago
README aed89adad5 Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 6 years ago
conf.py 0f2f517298 Bumped version; master is now 3.1 pre-alpha. 5 years ago
contents.txt bca9faae95 Fixed #26020 -- Normalized header stylings in docs. 9 years ago
glossary.txt bca9faae95 Fixed #26020 -- Normalized header stylings in docs. 9 years ago
index.txt 635a3f8e6e Refs #30451 -- Doc'd asynchronous support and async-safety. 5 years ago
make.bat 9b5f64cc6e Fixed #19516 - Fixed remaining broken links. 12 years ago
spelling_wordlist c90ab30fa1 Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable. 5 years ago

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/