django/docs
Mariusz Felisiak 3d16496037 Bumped asgiref requirement to >= 3.2.10.
Forwardported 3.1 release notes from 474f65406f.
2020-07-17 21:15:21 +02:00
..
_ext Made default_role_error use logger. 2020-06-03 11:42:42 +02:00
_theme Fixed #16300 -- Improved singlehtml docs formatting with headers CSS. 2020-06-22 21:05:13 +02:00
faq Removed reference to unsupported versions of Django and Python. 2020-06-03 21:28:14 +02:00
howto Corrected custom model fields how-to. 2020-07-10 11:11:40 +02:00
internals Bumped asgiref requirement to >= 3.2.10. 2020-07-17 21:15:21 +02:00
intro Updated How to install Django on Windows guide. 2020-06-03 16:28:10 +02:00
man Updated man page for Django 3.1 alpha. 2020-05-12 11:26:37 +02:00
misc
ref Improved ManyToManyField.through docs. 2020-07-17 10:29:24 +02:00
releases Bumped asgiref requirement to >= 3.2.10. 2020-07-17 21:15:21 +02:00
topics Refs #31502 -- Made minor edits to Model._state docs. 2020-07-16 20:50:53 +02:00
Makefile
README.rst
conf.py Bumped version; master is now 3.2 pre-alpha. 2020-05-13 09:07:51 +02:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt
index.txt
make.bat
spelling_wordlist Added Igbo language. 2020-07-14 20:44:41 +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/