1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
django/docs
2024-01-02 09:57:41 +01:00
..
_ext
_theme
faq Updated examples for 2.0+ release numbering in installation FAQ. 2023-12-15 06:16:02 +01:00
howto Refs #25778 -- Updated some links and references to HTTPS. 2023-11-29 11:21:22 +01:00
internals Fixed #35060 -- Deprecated passing positional arguments to Model.save()/asave(). 2024-01-02 08:42:33 +01:00
intro Corrected method/function wording in tutorial 3. 2023-12-29 06:01:18 +01:00
man
misc Refs #25778 -- Updated some links and references to HTTPS. 2023-11-29 11:21:22 +01:00
ref Fixed #35060 -- Deprecated passing positional arguments to Model.save()/asave(). 2024-01-02 08:42:33 +01:00
releases Added release date for 5.0.1 and 4.2.9. 2024-01-02 09:57:41 +01:00
topics Fixed #35060 -- Deprecated passing positional arguments to Model.save()/asave(). 2024-01-02 08:42:33 +01:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist Doc'd support for assistive technologies in the admin. 2023-11-17 09:29:24 +01: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/