mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-25 00:30:45 +00:00
Code Issues32 Releases Wiki Activity
90cf963264
django/docs
History
Adam Johnson 90cf963264 Changed django.utils.log.log_response() to take exception instance. 
There's little point retrieving a fresh reference to the exception in
the legacy tuple format, when it's all available via the exception
instance we already have.
2022-01-12 20:23:42 +01:00
..
_ext
Fixed crash building HTML docs since Sphinx 4.3.
2021-11-17 12:31:25 +01:00
_theme
Fixed -- Made docs permalinks focusable to improve accessibility.
2021-06-21 13:47:26 +02:00
faq
Refs -- Doc'd Python 3.10 compatibility in Django 3.2.x.
2021-10-05 13:30:41 +02:00
howto
Fixed -- Fixed typo in docs/howto/outputting-csv.txt.
2022-01-12 07:36:27 +01:00
internals
Refs -- Deprecated passing errors=None to SimpleTestCase.assertFormError()/assertFormsetErrors().
2022-01-06 17:29:32 +01:00
intro
Corrected module reference in contributing tutorial.
2021-11-03 07:47:27 +01:00
man
Updated man page for Django 4.0 alpha.
2021-09-20 20:55:10 +02:00
misc
Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
ref
Fixed typo in docs/ref/contrib/admin/index.txt.
2022-01-12 07:44:45 +01:00
releases
Changed django.utils.log.log_response() to take exception instance.
2022-01-12 20:23:42 +01:00
topics
Alphabetized field attributes in form topic docs.
2022-01-12 08:07:21 +01:00
conf.py
Refs -- Used XeLaTeX for PDF docs build.
2021-11-12 09:36:18 +01:00
contents.txt
Fixed -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
glossary.txt
Fixed -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
index.txt
Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
make.bat
Added spelling option to make.bat.
2021-04-30 14:04:22 +02:00
Makefile
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
README.rst
Refs -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
requirements.txt
Refs -- Corrected configuration for Read The Docs.
2021-11-03 18:35:27 +01:00
spelling_wordlist
Added 'formatter' to spelling wordlist.
2021-10-12 15:16:00 +02: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/