1
0
mirror of https://github.com/django/django.git synced 2025-01-12 11:26:23 +00:00
django/docs
Simon Charette 888b9042b3
Fixed -- Addressed crash when adding a GeneratedField with % literals.
A longer term solution is likely to have a better separation of parametrized
DDL altogether to handle checks, constraints, defaults, and generated fields
but such a change would require a significant refactor that isn't suitable
for a backport.

Thanks Adrian Garcia for the report.
2024-04-02 17:33:31 -03: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 Fixed typos in docstrings and docs. 2024-03-07 06:01:01 +01:00
internals Fixed -- Extended template style guide in docs. 2024-03-11 11:05:54 +01:00
intro Restored django.db.models.F import in final code snippet added at the beginning of tutorial 4. 2024-03-29 12:33:08 -03:00
man Updated man page for Django 5.0 alpha. 2023-09-18 09:25:34 -03:00
misc Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:11 +01:00
ref Fixed -- Moved template engine system checks to backend methods. 2024-03-27 08:14:54 +01:00
releases Fixed -- Addressed crash when adding a GeneratedField with % literals. 2024-04-02 17:33:31 -03:00
topics Fixed typo in docs/topics/signals.txt. 2024-03-28 13:45:04 -03:00
conf.py Bumped version; main is now 5.1 pre-alpha. 2023-09-18 22:12:40 +02:00
contents.txt Fixed -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Reorganized the Contributing to Django docs. 2024-01-11 22:25:27 -03:00
make.bat Refs -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Refs -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
README.rst Refs -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
requirements.txt Refs -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Fixed -- Allowed setting pragma options on SQLite. 2024-02-16 12:59:19 +01:00

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/