Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Carlton Gibson c0a34befea [4.0.x] Fixed #33585 -- Made example git repo URLs use HTTPS protocol. 
The SSH-based checkout requires additional configuration, which is
beneficial to defer for new contributors.

Follow up to 3c6a4fdb6d828a03e368632d88f8261cc30104da. This commit
updates the remaining examples.
Backport of 9fed515a251d488172feb1652bb5179344364fb3 from main
2022-03-22 12:12:47 +01:00
..
_ext
[4.0.x] Refs #33476 -- Refactored code to strictly match 88 characters line length.
2022-02-08 19:25:02 +01:00
_theme
Fixed #32860 -- Made docs permalinks focusable to improve accessibility.
2021-06-21 13:47:26 +02:00
faq
[4.0.x] Refs #32074 -- Doc'd Python 3.10 compatibility in Django 3.2.x.
2021-10-05 13:31:57 +02:00
howto
[4.0.x] Fixed #33048 -- Doc'd that DEBUG static files requests don't use middleware chain.
2022-01-26 12:02:43 +01:00
internals
[4.0.x] Fixed #33585 -- Made example git repo URLs use HTTPS protocol.
2022-03-22 12:12:47 +01:00
intro
[4.0.x] Refs #31676 -- Used term "merger" instead of "committer" in docs.
2022-03-22 11:14:07 +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
[4.0.x] Added missing backticks to function names.
2022-03-17 11:10:49 +01:00
releases
[4.0.x] Added missing backticks to function names.
2022-03-17 11:10:49 +01:00
topics
[4.0.x] Added missing backticks to function names.
2022-03-17 11:10:49 +01:00
conf.py
[4.0.x] Refs #33476 -- Refactored code to strictly match 88 characters line length.
2022-02-08 19:25:02 +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
[4.0.x] Refs #33247 -- Corrected configuration for Read The Docs.
2021-11-03 18:46:08 +01:00
spelling_wordlist
[4.0.x] Added 'formatter' to spelling wordlist.
2021-10-12 15:16:36 +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.