django

mirror of https://github.com/django/django.git synced 2025-01-13 03:47:26 +00:00

History

Kelechi Precious Nwachukwu 6b273a2165 [3.1.x] Added Igbo language. Backport of `2cd3e7eeaf` from master		2020-07-14 21:05:55 +02:00
..
_ext	[3.1.x] Made default_role_error use logger.	2020-06-03 11:43:37 +02:00
_theme	Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags.	2019-12-11 09:49:54 +01:00
faq	[3.1.x] Corrected FAQ link in docs/faq/help.txt.	2020-05-29 21:24:21 +02:00
howto	[3.1.x] Corrected custom model fields how-to.	2020-07-10 11:37:37 +02:00
internals	[3.1.x] Refs #31493 -- Replaced var with const/let in documentation JS.	2020-06-24 12:22:54 +02:00
intro	[3.1.x] Updated How to install Django on Windows guide.	2020-06-03 16:28:58 +02:00
man	[3.1.x] Updated man page for Django 3.1 beta.	2020-06-15 09:52:09 +02:00
misc	Expanded API stability docs to include our policy of continual improvement.	2019-11-18 20:37:46 +01:00
ref	[3.1.x] Fixed #21528 -- Added note about filtering form field's queryset based on instance to admin docs.	2020-07-13 23:02:05 +02:00
releases	[3.1.x] Added Igbo language.	2020-07-14 21:05:55 +02:00
topics	[3.1.x] Refs #27430 -- Added buffer argument to DiscoverRunner docs.	2020-07-10 19:06:40 +02:00
conf.py	[3.1.x] Bumped django_next_version in docs config.	2020-05-12 11:40:57 +02:00
contents.txt
glossary.txt
index.txt	Fixed #25712 -- Reorganized templates docs.	2020-04-30 08:12:09 +02:00
make.bat
Makefile
README.rst	Refs #25778 -- Updated sphinx-doc.org links to HTTPS.	2020-01-29 06:04:15 +01:00
spelling_wordlist	[3.1.x] Added Igbo language.	2020-07-14 21:05:55 +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/