mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-09 13:28:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Clifford Gama 93e18a87dd [5.2.x] Fixed ambiguous pronoun reference in docs/ref/models/fields.txt. 
Backport of 9cc3970eaa from main.
2025-01-24 18:46:43 +01:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme
faq [5.2.x] Fixed #36125 -- Switched docs to use chat.djangoproject.com when referencing the Discord server. 2025-01-22 18:23:33 -03:00
howto Fixed #35515 -- Added automatic model imports to shell management command. 2025-01-09 13:00:29 -03:00
internals [5.2.x] Clarified feature freeze tasks in docs/internals/howto-release-django.txt. 2025-01-23 11:29:20 -03:00
intro [5.2.x] Fixed #36125 -- Switched docs to use chat.djangoproject.com when referencing the Discord server. 2025-01-22 18:23:33 -03:00
man Updated man page for Django 5.2 alpha. 2025-01-15 21:11:20 +01:00
misc Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:11 +01:00
ref [5.2.x] Fixed ambiguous pronoun reference in docs/ref/models/fields.txt. 2025-01-24 18:46:43 +01:00
releases [5.2.x] Fixed typos in docs/releases/5.2.txt. 2025-01-16 13:15:24 +01:00
topics Fixed #36070 -- Clarified model validation behavior for composite pks. 2025-01-15 13:44:23 +01:00
conf.py [5.2.x] Bumped django_next_version in docs config. 2025-01-15 21:19:43 +01:00
contents.txt
glossary.txt
index.txt Replaced usage of "patch" with more precise terms in faq, howto, and intro docs. 2024-06-09 14:38:04 -03:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Added parallelism support via --jobs to docs build Makefile rule. 2024-11-27 18:15:25 -03:00
README.rst
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Removed unused and unnecessary words from docs/spelling_wordlist. 2024-12-09 09:34:18 +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/