mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-27 03:25:58 +00:00
Code Issues 30 Releases Wiki Activity
a0f46ea7e8
django/docs
History
Adam Johnson a0f46ea7e8 [4.2.x] Corrected example in CreateCollation() docs. 
Backport of 4db33e96d1 from main
2023-03-12 15:03:07 +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
ref [4.2.x] Corrected example in CreateCollation() docs. 2023-03-12 15:03:07 +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
glossary.txt
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
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/