django

mirror of https://github.com/django/django.git synced 2025-01-09 01:46:20 +00:00

History

Mariusz Felisiak fb9b1c245d Updated admin's XRegExp to 3.2.0.		2020-04-22 08:45:14 +02:00
..
_ext	Sorted imports in docs/_ext/djangodocs.py.	2020-04-14 07:31:36 +02:00
_theme
faq	Prevented (and corrected) single backtick usage in docs.	2020-04-01 14:55:11 +02:00
howto	Refs #29501 -- Allowed customizing exit status for management commands.	2020-04-14 13:22:47 +02:00
internals	Refs #22463 -- Replaced JSHint with ESLint in contributing docs.	2020-04-20 10:53:00 +02:00
intro	Fixed term warning on Sphinx 3.0.1+.	2020-04-14 09:32:09 +02:00
man
misc
ref	Capitalized Unicode in docs, strings, and comments.	2020-04-20 12:10:33 +02:00
releases	Updated admin's XRegExp to 3.2.0.	2020-04-22 08:45:14 +02:00
topics	Capitalized Unicode in docs, strings, and comments.	2020-04-20 12:10: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	Rewrote Get Help FAQ.	2020-03-26 09:44:00 +01:00
make.bat
Makefile
README.rst
spelling_wordlist	Capitalized Unicode in docs, strings, and comments.	2020-04-20 12:10:33 +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/