mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-24 10:05:46 +00:00
Code Issues 25 Releases Wiki Activity
caec4f4a6f
django/docs
History
Adam Johnson caec4f4a6f [4.2.x] Refs #34840 -- Improved release note describing index regression. 
Backport of 73b2c63127 from main
2023-10-15 10:28:07 +02:00
..
_ext [4.2.x] Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 09:32:03 +02:00
_theme
faq [4.2.x] Fixed #34545 -- Corrected the number of months in installation FAQ. 2023-05-08 08:34:47 +02:00
howto [4.2.x] Fixed typo in docs/howto/custom-file-storage.txt. 2023-09-16 07:40:17 +02:00
internals [4.2.x] Refs #34043 -- Clarified how to test UI changes. 2023-10-09 11:51:50 +02:00
intro [4.2.x] Reorganized tutorial's part 4 to better understand changes needed in URLConf. 2023-10-10 14:07:10 -03:00
man [4.2.x] Updated man page for Django 4.2 final. 2023-04-03 08:56:48 +02:00
misc
ref [4.2.x] Fixed #34808 -- Doc'd aggregate function's default argument. 2023-10-11 16:11:09 -03:00
releases [4.2.x] Refs #34840 -- Improved release note describing index regression. 2023-10-15 10:28:07 +02:00
topics [4.2.x] Fixed #34808 -- Doc'd aggregate function's default argument. 2023-10-11 16:11:09 -03:00
conf.py [4.2.x] Used extlinks for PyPI links. 2023-04-17 07:44:29 +02:00
contents.txt
glossary.txt
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
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 #33405, Refs #7177 -- Clarified docs for filter escapejs regarding safe and unsafe usages. 2023-07-03 13:55:31 +02: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/