django/docs
Fredrik c3ee42d663 Refs #20935 -- Removed inappropriate crosslink to docs search results page.
The link to the search page does not work in the Epub, since there is no such thing. In the online docs, the link to the search page displays a “No search query given” error, since its purpose is to display results from the search bar. Alone, without a query, it's just empty.
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 Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
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 Refs #20935 -- Removed inappropriate crosslink to docs search results page. 2019-12-04 11:36:40 +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
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00
conf.py Bumped version; master is now 3.1 pre-alpha. 2019-09-10 11:54:25 +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 Refs #30451 -- Doc'd asynchronous support and async-safety. 2019-12-03 17:29:10 +01:00
make.bat
spelling_wordlist Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable. 2019-12-03 17:29:31 +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/