Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Mariusz Felisiak d4b4c1cae4
Corrected used JS libraries in GIS widget docs. 
Follow up to 1833eb3f3e3bda5052637f1a51a27fa1b11b6871.
2023-01-10 14:25:44 +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
Updated various links to HTTPS and new locations.
2022-12-06 05:59:43 +01:00
internals
Refs #32355 -- Bumped minimum supported versions of 3rd-party packages.
2023-01-05 18:09:33 +01:00
intro
Fixed #34232 -- Fixed typo in docs/intro/tutorial07.txt.
2023-01-04 13:26:34 +01:00
man
Updated man page for Django 4.1 alpha.
2022-05-17 11:21:08 +02:00
misc
Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
ref
Corrected used JS libraries in GIS widget docs.
2023-01-10 14:25:44 +01:00
releases
Refs #31014 -- Added FromWKB and FromWKT GIS database functions.
2023-01-10 11:51:09 +01:00
topics
Fixed #34110 -- Added in-memory file storage.
2023-01-10 10:56:59 +01:00
conf.py
Disabled auto-created table of contents entries on Sphinx 5.2+.
2022-12-29 06:07:51 +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 #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
Refs DEP 12 -- Renamed TB to Steering Council wherever mentioned.
2022-12-20 09:10:59 +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.