1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
django/docs
2022-02-07 20:37:05 +01:00
..
_ext Refs #33476 -- Refactored code to strictly match 88 characters line length. 2022-02-07 20:37:05 +01:00
_theme Stopped including type="text/css" attributes for CSS link tags. 2022-01-22 16:38:14 +01:00
faq
howto Fixed #30360 -- Added support for secret key rotation. 2022-02-01 11:12:24 +01:00
internals Refs #33476 -- Adjusted docs and config files for Black. 2022-02-07 20:36:04 +01:00
intro Stopped including type="text/css" attributes for CSS link tags. 2022-01-22 16:38:14 +01:00
man
misc
ref Refs #33476 -- Used vertical hanging indentation for format lists with inline comments. 2022-02-01 15:11:35 +01:00
releases Refs #33476 -- Adjusted docs and config files for Black. 2022-02-07 20:36:04 +01:00
topics Refs #32243 -- Fixed typo in docs/topics/files.txt. 2022-02-05 11:19:22 +01:00
conf.py Refs #33476 -- Refactored code to strictly match 88 characters line length. 2022-02-07 20:37:05 +01:00
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/