django1/docs
Mariusz Felisiak 604df4e0ad
Refs #32074 -- Doc'd Python 3.10 compatibility in Django 3.2.x.
2021-10-05 13:30:41 +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 Removed versionadded/changed annotations for 3.2. 2021-09-20 21:23:01 +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 Fixed #22224 -- Added note about supplying missing values for non-nullable fields with blank=True. 2021-10-05 06:09:54 +02:00
releases Refs #32074 -- Doc'd Python 3.10 compatibility in Django 3.2.x. 2021-10-05 13:30:41 +02:00
topics Fixed #33128 -- Corrected possessive 's usage in FormSet docs. 2021-09-22 11:26:24 +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 Bumped version; main is now 4.1 pre-alpha. 2021-09-20 21:23:01 +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 Refs #32943 -- Added support for covering SP-GiST indexes on PostgreSQL 14+. 2021-10-01 13:11:34 +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/