Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Tim Schilling 757c456d23 [4.2.x] Fixed #34146 -- Added 3rd-party lib tutorial step. 
Added a tutorial step that highlights Django Debug Toolbar, on of the
most common third party packages. It also added a mention of
djangopackages.com as a place to search for other libraries and a
link to Adam Johnson’s post on evaluating whether a package is
well-maintained.

Third-party packages are one of Django’s strengths. This should give
folks a sound route in.

Backport of 7715c9fef55c8775608cdb64d5666c7f90ada937 and
1df7814e4b76211a13eaecd77a05137006b82723 from main
2023-02-07 20:22:11 +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] 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] Added stub release notes for 4.0.10 and 3.2.18.
2023-02-07 10:10:22 +01:00
topics
[4.2.x] Fixed #34310 -- Added deletion example to one-to-one topic.
2023-02-07 08:05:17 +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.