Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Willem Van Onsem 7a88b1f5aa [4.2.x] Fixed #34311 -- Updated serialization docs from unique_together to UniqueConstraint. 
Backport of 292aacaf6c3d6956ca2c51c41e36dbf425389346 from main
2023-02-09 05:56:31 +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
[4.2.x] Fixed #34146 -- Added 3rd-party lib tutorial step.
2023-02-07 20:22:11 +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] Added missing vars to AdminSite.each_context() docs.
2023-02-08 18:00:37 +01:00
releases
[4.2.x] Fixed #34319 -- Fixed Model.validate_constraints() crash on ValidationError with no code.
2023-02-08 16:39:53 +01:00
topics
[4.2.x] Fixed #34311 -- Updated serialization docs from unique_together to UniqueConstraint.
2023-02-09 05:56:31 +01:00
conf.py
[4.2.x] Bumped django_next_version in docs config.
2023-01-17 08:54:30 +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
[4.2.x] Fixed #34146 -- Added 3rd-party lib tutorial step.
2023-02-07 20:22:11 +01: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
[4.2.x] Fixed #34146 -- Added 3rd-party lib tutorial step.
2023-02-07 20:22:11 +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.