django

mirror of https://github.com/django/django.git synced 2024-12-28 03:55:50 +00:00

History

Jozef 6993e1bf6d Fixed typo in docs/topics/testing/advanced.txt.		2021-03-17 18:10:33 +01:00
..
_ext	Made default_role_error use logger.	2020-06-03 11:42:42 +02:00
_theme	Fixed #16300 -- Improved singlehtml docs formatting with headers CSS.	2020-06-22 21:05:13 +02:00
faq	Added stub release notes for 4.0.	2021-01-14 17:50:04 +01:00
howto	Updated links to DEPs.	2021-02-25 17:22:07 +01:00
internals	Updated link to Selenium webdrivers.	2021-03-09 11:29:54 +01:00
intro	Updated Git branch "master" to "main".	2021-03-09 08:48:32 +01:00
man	Updated django-admin man page for Django 3.2.	2021-01-14 14:58:28 +01:00
misc
ref	Fixed #32353 -- Confirmed support for PROJ 7.X.	2021-03-16 20:22:35 +01:00
releases	Fixed #32529 -- Delayed creating a test suite in build_suite().	2021-03-11 10:02:06 +01:00
topics	Fixed typo in docs/topics/testing/advanced.txt.	2021-03-17 18:10:33 +01:00
conf.py	Updated Git branch "master" to "main".	2021-03-09 08:48:32 +01:00
contents.txt
glossary.txt
index.txt	Fixed #25712 -- Reorganized templates docs.	2020-04-30 08:12:09 +02:00
make.bat
Makefile
README.rst
requirements.txt	Used GitHub actions for docs tests.	2021-02-26 22:12:25 +01:00
spelling_wordlist	Fixed #32018 -- Extracted admin colors into CSS variables.	2021-01-07 10:07:19 +01: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/