1
0
mirror of https://github.com/django/django.git synced 2025-01-12 19:37:06 +00:00
django/docs
2020-04-06 11:26:00 +02:00
..
_ext Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
_theme
faq Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
howto Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
internals Refs #7098 -- Deprecated passing raw column aliases to order_by(). 2020-04-06 10:01:02 +02:00
intro
man
misc
ref Corrected docs spelling of PgBouncer. 2020-04-01 14:55:11 +02:00
releases Fixed #31030 -- Registered SQLite functions as deterministic on Python 3.8+. 2020-04-06 11:26:00 +02:00
topics Fixed #31423 -- Clarified nested atomic() example. 2020-04-04 20:39:33 +02:00
conf.py Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
spelling_wordlist Corrected docs spelling of PgBouncer. 2020-04-01 14:55:11 +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/