mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity
e459b0f5a0
django/docs
History
Mike Lissner e459b0f5a0
Improved example of using a custom queryset in Model formsets docs.
2022-02-03 06:58:14 +01:00
..
_ext Fixed crash building HTML docs since Sphinx 4.3. 2021-11-17 12:31:25 +01:00
_theme Stopped including type="text/css" attributes for CSS link tags. 2022-01-22 16:38:14 +01:00
faq Refs #32074 -- Doc'd Python 3.10 compatibility in Django 3.2.x. 2021-10-05 13:30:41 +02:00
howto Fixed #30360 -- Added support for secret key rotation. 2022-02-01 11:12:24 +01:00
internals Fixed #29984 -- Added QuerySet.iterator() support for prefetching related objects. 2022-01-25 06:12:04 +01:00
intro Stopped including type="text/css" attributes for CSS link tags. 2022-01-22 16:38:14 +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 Refs #33476 -- Used vertical hanging indentation for format lists with inline comments. 2022-02-01 15:11:35 +01:00
releases Fixed typo in release notes. 2022-02-02 07:17:57 +01:00
topics Improved example of using a custom queryset in Model formsets docs. 2022-02-03 06:58:14 +01:00
conf.py Refs #33247 -- Used XeLaTeX for PDF docs build. 2021-11-12 09:36:18 +01: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 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 #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
requirements.txt Refs #33247 -- 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/