0
0
mirror of https://github.com/django/django.git synced 2024-11-24 20:07:01 +01:00
django/docs
2021-01-14 17:50:04 +01:00
..
_ext
_theme Fixed #16300 -- Improved singlehtml docs formatting with headers CSS. 2020-06-22 21:05:13 +02:00
faq Added stub release notes for 4.0. 2021-01-14 17:50:04 +01:00
howto Removed versionadded/changed annotations for 3.1. 2021-01-14 17:50:04 +01:00
internals Fixed typo in docs/internals/contributing/writing-code/coding-style.txt. 2021-01-09 20:18:00 +01:00
intro Fixed #16117 -- Added decorators for admin action and display functions. 2021-01-13 17:19:22 +01:00
man Updated django-admin man page for Django 3.2. 2021-01-14 14:58:28 +01:00
misc
ref Refs #15902 -- Stopped set_language() storing user's language in the session. 2021-01-14 17:50:04 +01:00
releases Refs #30158 -- Made alias argument required in signature of Expression.get_group_by_cols() subclasses. 2021-01-14 17:50:04 +01:00
topics Removed versionadded/changed annotations for 3.1. 2021-01-14 17:50:04 +01:00
conf.py Bumped version; master is now 4.0 pre-alpha. 2021-01-14 17:50:04 +01:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
spelling_wordlist Fixed #32018 -- Extracted admin colors into CSS variables. 2021-01-07 10:07:19 +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/