django/docs
Simon Charette 156a2138db Refs #30446 -- Removed unnecessary Value(..., output_field) in docs and tests. 2020-07-15 10:58:38 +02:00
..
_ext
_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 Refs #31493 -- Replaced var with const/let in documentation JS. 2020-06-24 12:20:57 +02:00
intro
man
misc
ref Refs #30446 -- Removed unnecessary Value(..., output_field) in docs and tests. 2020-07-15 10:58:38 +02:00
releases Fixed #30446 -- Resolved Value.output_field for stdlib types. 2020-07-15 10:58:29 +02:00
topics Fixed #30457 -- Added TestCase.captureOnCommitCallbacks(). 2020-07-13 11:56:46 +02:00
Makefile
README.rst
conf.py
contents.txt
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/