django/docs
Jacob Walls 6c6606aa01 Refs #34233 -- Bumped minimum supported version of docutils to 0.19. 2023-09-04 22:30:45 +02:00
..
_ext Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 08:01:06 +02:00
_theme
faq
howto Fixed #34768 -- Avoided initializing colorama on non-Windows platforms. 2023-09-01 11:26:29 +02:00
internals Refs #34233 -- Bumped minimum supported version of docutils to 0.19. 2023-09-04 22:30:45 +02:00
intro Fixed typo in docs/intro/tutorial08.txt. 2023-06-28 07:08:51 +02:00
man
misc
ref Refs #34233 -- Bumped minimum supported version of docutils to 0.19. 2023-09-04 22:30:45 +02:00
releases Refs #34233 -- Bumped minimum supported version of docutils to 0.19. 2023-09-04 22:30:45 +02:00
topics Fixed #34210 -- Added unittest's durations option to the test runner. 2023-08-31 07:14:58 +02:00
Makefile
README.rst
conf.py Removed unneeded escapes in regexes. 2023-08-02 19:53:16 +02:00
contents.txt
glossary.txt
index.txt
make.bat
requirements.txt
spelling_wordlist Added Uyghur language. 2023-08-12 20:37:15 +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/