mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-01 12:24:31 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Carlton Gibson 50432e3fd5 [4.2.x] Set date and added stub release notes for 4.1.6, 4.0.9, and 3.2.17. 
Backport of 1df963ad2476726d63be132c0cee47e07b8250d7 from main
2023-01-25 11:58:35 +01:00
..
_ext
Refs #33476 -- Refactored code to strictly match 88 characters line length.
2022-02-07 20:37:05 +01:00
_theme
Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-05-31 11:17:01 +02:00
faq
Refs #33173 -- Doc'd Python 3.11 compatibility in Django 4.1.x.
2022-10-26 20:10:33 +02:00
howto
Refs #26029 -- Deprecated DEFAULT_FILE_STORAGE and STATICFILES_STORAGE settings.
2023-01-12 09:58:36 +01:00
internals
Refs #26029 -- Deprecated DEFAULT_FILE_STORAGE and STATICFILES_STORAGE settings.
2023-01-12 09:58:36 +01:00
intro
Fixed #34232 -- Fixed typo in docs/intro/tutorial07.txt.
2023-01-04 13:26:34 +01:00
man
Updated man page for Django 4.2 alpha.
2023-01-17 08:51:17 +01:00
misc
Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
ref
[4.2.x] Fixed #34242 -- Doc'd that primary key is set to None when deleting objects.
2023-01-20 10:57:30 +01:00
releases
[4.2.x] Set date and added stub release notes for 4.1.6, 4.0.9, and 3.2.17.
2023-01-25 11:58:35 +01:00
topics
Fixed #23718 -- Doc'd that test mirrors require TransactionTestCase.
2023-01-16 09:31:34 +01:00
conf.py
[4.2.x] Bumped django_next_version in docs config.
2023-01-17 08:54:30 +01:00
contents.txt
…
glossary.txt
…
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 #33753 -- Fixed docs build on Sphinx 5+.
2022-06-01 12:13:15 +02:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
requirements.txt
Bumped minimum Sphinx version to 4.5.0 in docs/requirements.txt.
2022-09-26 11:18:15 +02:00
spelling_wordlist
Refs DEP 12 -- Renamed TB to Steering Council wherever mentioned.
2022-12-20 09:10:59 +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/