django/docs
Mariusz Felisiak 37fc832a54
Fixed #35006 -- Fixed migrations crash when altering Meta.db_table_comment on SQLite.
Thanks Юрий for the report.

Regression in 78f163a4fb.
2023-11-30 10:10:27 +01:00
..
_ext Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 08:01:06 +02:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Added VoiceOver iOS and macOS separately in admin FAQ. 2023-11-21 05:45:50 +01:00
howto Refs #25778 -- Updated some links and references to HTTPS. 2023-11-29 11:21:22 +01:00
internals Improved structure of Contributing Guide start page. 2023-11-30 08:33:29 +01:00
intro Refs #34118 -- Doc'd Python 3.12 compatibility in Django 4.2.x. 2023-11-19 16:31:46 +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 Updated conditions to retrieve primary keys in bulk_create() docs. 2023-11-29 11:57:53 +01:00
releases Fixed #35006 -- Fixed migrations crash when altering Meta.db_table_comment on SQLite. 2023-11-30 10:10:27 +01:00
topics Refs #25778 -- Updated some links and references to HTTPS. 2023-11-29 11:21:22 +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 Added Django Forum to mailing lists page. 2023-03-24 08:32:17 +01: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 Doc'd support for assistive technologies in the admin. 2023-11-17 09:29:24 +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/