django/docs
Mariusz Felisiak 305757aec1
Applied Black's 2024 stable style.
https://github.com/psf/black/releases/tag/24.1.0
2024-01-26 12:45:07 +01:00
..
_ext Applied Black's 2024 stable style. 2024-01-26 12:45:07 +01:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Updated examples for 2.0+ release numbering in installation FAQ. 2023-12-15 06:16:02 +01:00
howto Applied Black's 2024 stable style. 2024-01-26 12:45:07 +01:00
internals Applied Black's 2024 stable style. 2024-01-26 12:45:07 +01:00
intro Applied Black's 2024 stable style. 2024-01-26 12:45:07 +01:00
man Updated man page for Django 5.0 alpha. 2023-09-18 09:25:34 -03:00
misc Refs #25778 -- Updated some links and references to HTTPS. 2023-11-29 11:21:22 +01:00
ref Applied Black's 2024 stable style. 2024-01-26 12:45:07 +01:00
releases Applied Black's 2024 stable style. 2024-01-26 12:45:07 +01:00
topics Applied Black's 2024 stable style. 2024-01-26 12:45:07 +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 Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Bumped version; main is now 5.1 pre-alpha. 2023-09-18 22:12:40 +02:00
contents.txt
glossary.txt
index.txt Reorganized the Contributing to Django docs. 2024-01-11 22:25:27 -03:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Fixed #35075 -- Added deduplicate_items parameter to BTreeIndex. 2024-01-02 12:55:12 +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/