Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Mariusz Felisiak a9ed890837 [4.1.x] Disabled auto-created table of contents entries on Sphinx 5.2+. 
Auto-created table of contents entries for all domain objects (e.g.
functions, classes, attributes, etc.) were added in Sphinx 5.2, see
https://github.com/sphinx-doc/sphinx/issues/6316.

An option to control new table of contents entries was added in Sphinx
5.2.3, see https://github.com/sphinx-doc/sphinx/pull/10886.
Backport of 279967ec859a9a5240318cf29a077539b0e3139f from main
2022-12-29 06:09:17 +01:00
..
_ext
Refs #33476 -- Refactored code to strictly match 88 characters line length.
2022-02-07 20:37:05 +01:00
_theme
[4.1.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-06-27 07:44:27 +02:00
faq
[4.1.x] Refs #33173 -- Doc'd Python 3.11 compatibility in Django 4.1.x.
2022-10-26 20:13:41 +02:00
howto
[4.1.x] Updated various links to HTTPS and new locations.
2022-12-06 06:00:34 +01:00
internals
[4.1.x] Refs DEP 12 -- Renamed TB to Steering Council wherever mentioned.
2022-12-20 09:12:41 +01:00
intro
[4.1.x] Updated UTC uses to datetime.timezone.utc in docs.
2022-10-20 15:53:59 -07:00
man
[4.1.x] Updated man page for Django 4.1.3.
2022-11-01 07:02:20 +01:00
misc
Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
ref
[4.1.x] Fixed #34213 -- Updated PostgreSQL package names in installing PostGIS docs.
2022-12-14 16:50:44 +01:00
releases
[4.1.x] Updated translations from Transifex.
2022-12-20 19:33:28 +01:00
topics
[4.1.x] Fixed typo in docs/topics/async.txt.
2022-12-19 20:26:29 +01:00
conf.py
[4.1.x] Disabled auto-created table of contents entries on Sphinx 5.2+.
2022-12-29 06:09:17 +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
[4.1.x] Fixed #33753 -- Fixed docs build on Sphinx 5+.
2022-06-01 12:13:38 +02:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
requirements.txt
Rewrote strip_tags test file to lorem ipsum.
2022-03-08 14:50:06 +01:00
spelling_wordlist
[4.1.x] Refs DEP 12 -- Renamed TB to Steering Council wherever mentioned.
2022-12-20 09:12:41 +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.