django/docs
dennisvang 7bb741d787 Fixed #34325 -- Corrected wording in PercentRank() docs.
This is consistent with the terminology used for the percent_rank()
function in SQLite docs and PostgreSQL docs.
2023-02-10 14:07:48 +01:00
..
_ext Refs #33476 -- Refactored code to strictly match 88 characters line length. 2022-02-07 20:37:05 +01:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Added stub release notes for 5.0. 2023-01-17 11:49:15 +01:00
howto Refs #34233 -- Used str.removeprefix()/removesuffix(). 2023-01-18 19:11:18 +01:00
internals Fixed #34324 -- Mentioned Discord server in contributing index. 2023-02-10 05:55:45 +01:00
intro Refs #34146 -- Fixed typos in tutorial. (#16530) 2023-02-07 20:19:58 +01:00
man Updated man page for Django 4.2 alpha. 2023-01-17 08:51:17 +01:00
misc Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
ref Fixed #34325 -- Corrected wording in PercentRank() docs. 2023-02-10 14:07:48 +01:00
releases Fixed #34303 –- Allowed customizing admin site log entry list. 2023-02-08 18:37:32 +01:00
topics Fixed #34311 -- Updated serialization docs from unique_together to UniqueConstraint. 2023-02-09 05:28:03 +01:00
Makefile Fixed #33753 -- Fixed docs build on Sphinx 5+. 2022-06-01 12:13:15 +02:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Bumped version; master is now 5.0 pre-alpha. 2023-01-17 11:49:15 +01:00
contents.txt
glossary.txt
index.txt Refs #34146 -- Fixed typos in tutorial. (#16530) 2023-02-07 20:19:58 +01:00
make.bat Added spelling option to make.bat. 2021-04-30 14:04:22 +02:00
requirements.txt Bumped minimum Sphinx version to 4.5.0 in docs/requirements.txt. 2022-09-26 11:18:15 +02:00
spelling_wordlist Fixed #34146 -- Added 3rd-party lib tutorial step. 2023-02-07 15:26:37 +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/