mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-06 07:22:32 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Mariusz Felisiak 2e57dc490b [4.2.x] Doc'd that action descriptions are %-formatted. 
Co-authored-by: JD Bothma <jbothma@gmail.com>

Backport of cc67344db9de0248ba1064f7e986c6b29276a7b1 from main
2023-03-09 15:44:40 +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
[4.2.x] Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.
2023-03-01 13:39:03 +01:00
howto
[4.2.x] Refs #31626 -- Noted that Daphne provides a runserver command.
2023-03-07 19:48:49 +01:00
internals
[4.2.x] Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.
2023-03-01 13:39:03 +01:00
intro
[4.2.x] Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.
2023-03-01 13:39:03 +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] Doc'd that action descriptions are %-formatted.
2023-03-09 15:44:40 +01:00
releases
[4.2.x] Fixed #34395 -- Updated admin's jQuery to 3.6.4.
2023-03-09 08:55:34 +01:00
topics
[4.2.x] Fixed #34384 -- Fixed session validation when rotation secret keys.
2023-03-08 11:33:03 +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
[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.

.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/