1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
django/docs
2021-10-12 15:19:39 +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 Refs #32074 -- Doc'd Python 3.10 compatibility in Django 3.2.x. 2021-10-05 13:30:41 +02:00
howto Improved docs regarding UTF-8 support with Apache and mod_wsgi. 2021-10-08 12:26:06 +02:00
internals Dropped easy_install example from Release How-To. 2021-10-05 10:48:37 +02:00
intro Recommended using .tables on SQLite in tutorial 2. 2021-09-29 12:42:59 +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 Improved docs regarding UTF-8 support with Apache and mod_wsgi. 2021-10-08 12:26:06 +02:00
releases Fixed #29470 -- Logged makemigrations automatic decisions in non-interactive mode. 2021-10-12 15:19:39 +02:00
topics Fixed #33128 -- Corrected possessive 's usage in FormSet docs. 2021-09-22 11:26:24 +02:00
conf.py Bumped version; main is now 4.1 pre-alpha. 2021-09-20 21:23:01 +02:00
contents.txt
glossary.txt
index.txt Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist Added 'formatter' to spelling wordlist. 2021-10-12 15:16:00 +02:00

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/