Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Jannis Vajen 4eaed191b6 [4.2.x] Corrected code-block directives in docs. 
Backport of 024954aad4c422a091b7afab42fff1a9d7478fce from main
2023-05-04 19:34:19 +02: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
[4.2.x] Fixed typos in docs/faq/contributing.txt.
2023-04-06 21:40:35 +02:00
howto
[4.2.x] Used extlinks for PyPI links.
2023-04-17 07:44:29 +02:00
internals
[4.2.x] Updated Django Transifex links.
2023-04-22 16:19:12 +02:00
intro
[4.2.x] Used extlinks for PyPI links.
2023-04-17 07:44:29 +02:00
man
[4.2.x] Updated man page for Django 4.2 final.
2023-04-03 08:56:48 +02: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] Corrected code-block directives in docs.
2023-05-04 19:34:19 +02:00
releases
[4.2.x] Added CVE-2023-31047 to security archive.
2023-05-03 15:21:47 +02:00
topics
[4.2.x] Fixed CVE-2023-31047, Fixed #31710 -- Prevented potential bypass of validation when uploading multiple files using one form field.
2023-05-03 13:43:16 +02:00
conf.py
[4.2.x] Used extlinks for PyPI links.
2023-04-17 07:44:29 +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
[4.2.x] Added Django Forum to mailing lists page.
2023-03-24 08:58:45 +01:00
make.bat
[4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:34:28 +01:00
Makefile
[4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:34:28 +01:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
requirements.txt
[4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:34:28 +01: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.