django1

History

Jero Bado 1350187f8e [4.0.x] Fixed typo in 4.0 release notes. Backport of `3f2170f720` from main		2021-09-22 15:17:40 +02:00
..
_ext	Refs #32956 -- Corrected spelling of "gray".	2021-08-02 07:51:24 +02:00
_theme	Fixed #32860 -- Made docs permalinks focusable to improve accessibility.	2021-06-21 13:47:26 +02:00
faq	Fixed some broken links and redirects in docs.	2021-08-09 07:07:52 +02:00
howto	Fixed #25264 -- Allowed suppressing base command options in --help output.	2021-08-31 11:04:02 +02:00
internals	Fixed #31026 -- Switched form rendering to template engine.	2021-09-20 15:50:18 +02:00
intro	Fixed typo in docs/intro/reusable-apps.txt.	2021-09-17 20:19:26 +02:00
man	Updated man page for Django 4.0 alpha.	2021-09-20 20:55:10 +02:00
misc	Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.	2021-07-29 06:24:12 +02:00
ref	[4.0.x] Fixed broken links and redirects in docs.	2021-09-21 09:28:38 +02:00
releases	[4.0.x] Fixed typo in 4.0 release notes.	2021-09-22 15:17:40 +02:00
topics	[4.0.x] Fixed #33128 -- Corrected possessive 's usage in FormSet docs.	2021-09-22 11:56:40 +02:00
Makefile	Fixed docs build with Sphinx 1.6.	2017-05-24 09:13:26 -04:00
README.rst	Refs #25778 -- Updated sphinx-doc.org links to HTTPS.	2020-01-29 06:04:15 +01:00
conf.py	[4.0.x] Bumped django_next_version in docs config.	2021-09-20 21:00:55 +02: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
requirements.txt	Used GitHub actions for docs tests.	2021-02-26 22:12:25 +01:00
spelling_wordlist	Fixed #33012 -- Added Redis cache backend.	2021-09-14 15:50:08 +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/