django

mirror of https://github.com/django/django.git synced 2024-12-27 19:46:22 +00:00

History

Adam Johnson a57e91adee Improved pagination documentation * Link to the topic guide * Document that page() can raise PageNotAnInteger.		2021-02-11 14:17:01 +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	Refs #32394 -- Changed STATIC_URL/MEDIA_URL to relative paths in tests and docs where appropriate.	2021-02-06 13:41:35 +01:00
internals	Fixed #32355 -- Dropped support for Python 3.6 and 3.7	2021-02-10 10:20:54 +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
ref	Improved pagination documentation	2021-02-11 14:17:01 +01:00
releases	Fixed #32421 -- Made admindocs ModelDetailView show model cached properties.	2021-02-11 06:50:50 +01:00
topics	Fixed #28216 -- Added next_page/get_default_redirect_url() to LoginView.	2021-02-08 21:08:05 +01:00
conf.py	Bumped version; master is now 4.0 pre-alpha.	2021-01-14 17:50:04 +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
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/