mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-03 18:38:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
django/docs
History
Sarah Boyce 3d9694d942 [5.2.x] Updated man page for Django 5.2 beta.
2025-02-19 11:43:27 +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 [5.2.x] Fixed #36158 -- Refactored shell command to improve auto-imported objects reporting. 2025-02-13 16:03:09 +01:00
internals [5.2.x] Specified "django" repository for twine call in docs/internals/howto-release-django.txt. 2025-02-10 22:54:26 -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 [5.2.x] Updated man page for Django 5.2 beta. 2025-02-19 11:43:27 +01:00
misc Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:11 +01:00
ref [5.2.x] Removed advice to propose a new contrib app. 2025-02-18 16:11:08 +01:00
releases [5.2.x] Fixed #36197 -- Fixed improper many-to-many count() and exists() for non-pk to_field. 2025-02-18 11:44:46 +01:00
topics [5.2.x] Refs #35967 -- Doc'd DatabaseCreation.serialize_db_to_string() method. 2025-02-16 13:43:45 +01:00
conf.py [5.2.x] Fixed docs build on Sphinx 8.2+. 2025-02-19 09:46:18 +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 [5.2.x] Fixed #36162 -- Fixed the black Makefile docs rule to work on macOS. 2025-02-01 22:28:35 -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/