django/docs
Ben Li-Sauerwine fc84848cd9
Made logging config examples more accessible.
- Show an initial example configuring the root logger to output to the console.
- Then add more logging from the `django` named logger.
- Then show the file and more complex examples.

Adjusted surrounding text for reading flow.

Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
2020-03-17 11:51:05 +01:00
..
_ext
_theme Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags. 2019-12-11 09:49:54 +01:00
faq Fixed #31032 -- Updated admin browser support FAQ for 2020. 2020-02-28 12:39:14 +01:00
howto Clarified SeparateDatabaseAndState docs and added example of changing ManyToManyField. 2020-03-10 11:07:36 +01:00
internals Fixed #8760 -- Changed ModelMultipleChoiceField to use invalid_list as a error message key. 2020-03-12 09:36:01 +01:00
intro Updated migrations example in tutorial 2. 2020-03-10 08:53:28 +01:00
man
misc
ref Fixed #31340 -- Allowed query expressions in SearchQuery.value and __search lookup. 2020-03-16 10:27:23 +01:00
releases Fixed #31340 -- Allowed query expressions in SearchQuery.value and __search lookup. 2020-03-16 10:27:23 +01:00
topics Made logging config examples more accessible. 2020-03-17 11:51:05 +01:00
Makefile
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Fixed #28290 -- Enabled Sphinx auto-label generation for title and section headers. 2020-01-29 14:34:14 +01:00
contents.txt
glossary.txt
index.txt Fixed typo in docs/index.txt. 2020-01-03 07:53:31 +01:00
make.bat
spelling_wordlist Refs #31224 -- Doc'd async adapter functions. 2020-03-13 07:13:44 +01:00

README.rst

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses `ReST`_ (reStructuredText), and the `Sphinx`_ documentation system.
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.

.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/