django/docs
tim-mccurrach 7587139d35
Fixed #20423 -- Doc'd that DTL variable names may not be a number.
2021-02-26 21:02:37 +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 Fixed #32446 -- Deprecated SERIALIZE test database setting. 2021-02-24 20:31:11 +01:00
intro Refs #30944 -- Added pyproject.toml in reusable apps docs. 2021-02-11 12:44:38 +01:00
man Updated django-admin man page for Django 3.2. 2021-01-14 14:58:28 +01:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Fixed #20423 -- Doc'd that DTL variable names may not be a number. 2021-02-26 21:02:37 +01:00
releases Fixed typos in assertQuerysetEqual() docs and 1.6 release notes. 2021-02-26 09:10:52 +01:00
topics Fixed typos in assertQuerysetEqual() docs and 1.6 release notes. 2021-02-26 09:10:52 +01:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Added documentation extlink for bugs.python.org. 2021-02-17 14:24:42 +01:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat
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/