1
0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
django/docs
2021-04-27 10:43:35 +02:00
..
_ext
_theme
faq Fixed #32652 -- Fixed links to new contributors FAQ. 2021-04-15 17:14:22 +02:00
howto Fixed #32667 -- Added link to labeling checks in BaseCommand.requires_system_checks docs. 2021-04-21 16:40:04 +02:00
internals Added note to update docs config when creating new stable branch. 2021-04-22 08:08:38 +02:00
intro Refs #28034 -- Corrected docs example in contributing tutorial. 2021-04-23 15:24:16 +02:00
man
misc
ref Refs #32682 -- Renamed use_distinct variable to may_have_duplicates. 2021-04-27 10:34:47 +02:00
releases Fixed #32687 -- Restored passing process’ environment to underlying tool in dbshell on PostgreSQL. 2021-04-27 10:43:35 +02:00
topics Fixed #32667 -- Added link to labeling checks in BaseCommand.requires_system_checks docs. 2021-04-21 16:40:04 +02:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt
spelling_wordlist

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/