django/docs
Mariusz Felisiak e1c74bf458 [4.2.x] Refs #21080, Refs #34322 -- Added warning to ManifestStaticFilesStorage docs about paths in comments.
Backport of bae053d497 from main.
2023-02-16 19:20:41 +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] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
howto [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
internals [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
intro [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +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] Refs #21080, Refs #34322 -- Added warning to ManifestStaticFilesStorage docs about paths in comments. 2023-02-16 19:20:41 +01:00
releases [4.2.x] Added CVE-2023-24580 to security archive. 2023-02-14 09:53:00 +01:00
topics [4.2.x] Refs #32339 -- Doc'd BaseFormSet.as_div() 2023-02-15 09:24:59 +01: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
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 Added spelling option to make.bat. 2021-04-30 14:04:22 +02: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 [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/