1
0
mirror of https://github.com/django/django.git synced 2025-01-12 19:37:06 +00:00
django/docs
2024-10-09 09:12:58 -03:00
..
_ext
_theme
faq Refs -- Doc'd Python 3.13 compatibility. 2024-10-09 09:27:33 +02:00
howto Refs -- Doc'd Python 3.13 compatibility. 2024-10-09 09:27:33 +02:00
internals
intro Fixed -- Removed duplication of "mysite" directory name in intro docs. 2024-10-09 09:12:58 -03:00
man
misc
ref Fixed -- Implemented async auth backends and utils. 2024-10-07 14:19:41 +02:00
releases Refs -- Doc'd Python 3.13 compatibility. 2024-10-09 09:27:33 +02:00
topics Refs -- Clarified models.py file path in docs/topics/db/queries.txt. 2024-10-09 09:12:58 -03:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist Fixed -- Removed duplication of "mysite" directory name in intro docs. 2024-10-09 09:12:58 -03: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/