django/docs
Mariusz Felisiak caa2dd08c4 Refs #31676 -- Removed Core team from organization docs.
According to DEP 0010.
2021-07-30 10:52:43 +02:00
..
_ext Made default_role_error use logger. 2020-06-03 11:42:42 +02:00
_theme Fixed #32860 -- Made docs permalinks focusable to improve accessibility. 2021-06-21 13:47:26 +02:00
faq Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
howto Refs #32880 -- Made remaining titles consistent in how-to documents. 2021-07-29 19:11:42 +02:00
internals Refs #31676 -- Removed Core team from organization docs. 2021-07-30 10:52:43 +02:00
intro Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
man Updated django-admin man page for Django 3.2. 2021-01-14 14:58:28 +01:00
misc Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
ref Made minor edits to QuerySet.update_or_create() docs. 2021-07-29 06:51:09 +02:00
releases Refs #32916 -- Replaced request.csrf_cookie_needs_reset with request.META['CSRF_COOKIE_NEEDS_UPDATE']. 2021-07-29 11:55:36 +02:00
topics Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +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 Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +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 Removed unused and unnecessary words from docs/spelling_wordlist. 2021-07-30 06:53:00 +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/