1
0
mirror of https://github.com/django/django.git synced 2025-01-12 03:15:47 +00:00
django/docs
Carlton Gibson b784768eef [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples.
Thanks to J.V. Zammit, Paolo Melchiorre, and Mariusz Felisiak for
reviews.

Backport of 534ac48297 from main.
2023-02-10 21:12:06 +01:00
..
_ext
_theme
faq [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
howto [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
internals [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
intro [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
man Updated man page for Django 4.2 alpha. 2023-01-17 08:51:17 +01:00
misc
ref [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
releases [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
topics [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
conf.py [4.2.x] Bumped django_next_version in docs config. 2023-01-17 08:54:30 +01:00
contents.txt
glossary.txt
index.txt [4.2.x] Fixed #34146 -- Added 3rd-party lib tutorial step. 2023-02-07 20:22:11 +01:00
make.bat
Makefile
README.rst
requirements.txt Bumped minimum Sphinx version to 4.5.0 in docs/requirements.txt. 2022-09-26 11:18:15 +02:00
spelling_wordlist [4.2.x] Fixed #34146 -- Added 3rd-party lib tutorial step. 2023-02-07 20:22:11 +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/