1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
2023-09-11 06:07:47 +02:00
..
_ext Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 08:01:06 +02:00
_theme
faq Fixed #34545 -- Corrected the number of months in installation FAQ. 2023-05-08 08:34:23 +02:00
howto Fixed #34768 -- Avoided initializing colorama on non-Windows platforms. 2023-09-01 11:26:29 +02:00
internals Refs #34233 -- Bumped minimum supported version of docutils to 0.19. 2023-09-04 22:30:45 +02:00
intro Fixed typo in docs/intro/tutorial08.txt. 2023-06-28 07:08:51 +02:00
man Updated man page for Django 4.2 alpha. 2023-01-17 08:51:17 +01:00
misc
ref Fixed #34642 -- Added File.open() support for *args and **kwargs. 2023-09-11 06:07:47 +02:00
releases Fixed #34642 -- Added File.open() support for *args and **kwargs. 2023-09-11 06:07:47 +02:00
topics Fixed #34210 -- Added unittest's durations option to the test runner. 2023-08-31 07:14:58 +02:00
conf.py Removed unneeded escapes in regexes. 2023-08-02 19:53:16 +02:00
contents.txt
glossary.txt
index.txt Added Django Forum to mailing lists page. 2023-03-24 08:32:17 +01:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
README.rst
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Added Uyghur language. 2023-08-12 20:37:15 +02: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/