Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Carlton Gibson 04d8ed3660 [3.2.x] Added stub release notes for Django 3.2.2. 
Backport of 5a43cfe24533591a020ba4e730440bad81c478db from main
2021-05-04 11:02:11 +02:00
..
_ext
Made default_role_error use logger.
2020-06-03 11:42:42 +02:00
_theme
Fixed #16300 -- Improved singlehtml docs formatting with headers CSS.
2020-06-22 21:05:13 +02:00
faq
[3.2.x] Fixed #32652 -- Fixed links to new contributors FAQ.
2021-04-15 17:16:22 +02:00
howto
[3.2.x] Refs #32694 -- Clarified when colorama requirement is needed in Windows how-to.
2021-04-29 11:27:39 +02:00
internals
[3.2.x] Refs #32178 -- Doc'd DatabaseFeatures.django_test_skips/django_test_expected_failures in contributing guide.
2021-04-29 20:56:08 +02:00
intro
[3.2.x] Refs #28034 -- Corrected docs example in contributing tutorial.
2021-04-23 15:25:12 +02:00
man
[3.2.x] Updated manpage for Django 3.2 final.
2021-04-06 11:02:06 +02:00
misc
Expanded API stability docs to include our policy of continual improvement.
2019-11-18 20:37:46 +01:00
ref
[3.2.x] Refs #32674 -- Noted that auto-created through table PKs cannot be automatically migrated.
2021-04-29 15:14:15 +02:00
releases
[3.2.x] Added stub release notes for Django 3.2.2.
2021-05-04 11:02:11 +02:00
topics
[3.2.x] Fixed #32667 -- Added link to labeling checks in BaseCommand.requires_system_checks docs.
2021-04-21 16:40:33 +02:00
conf.py
[3.2.x] Bumped django_next_version in docs config.
2021-04-10 19:06:18 +02: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 #25712 -- Reorganized templates docs.
2020-04-30 08:12:09 +02:00
make.bat
[3.2.x] Added spelling option to make.bat.
2021-04-30 14:09:59 +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
spelling_wordlist
Fixed #32018 -- Extracted admin colors into CSS variables.
2021-01-07 10:07:19 +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.