mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-24 05:36:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Sarah Boyce d5fec03dad Refs #35060 -- Removed passing positional arguments to Model.save()/asave() per deprecation timeline.
2025-01-15 22:28:37 +01:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Added stub release notes for 6.0. 2025-01-15 22:28:37 +01:00
howto Fixed #35515 -- Added automatic model imports to shell management command. 2025-01-09 13:00:29 -03:00
internals Removed versionadded/changed annotations for 5.1. 2025-01-15 22:28:37 +01:00
intro Fixed #35515 -- Added automatic model imports to shell management command. 2025-01-09 13:00:29 -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 Refs #35060 -- Removed passing positional arguments to Model.save()/asave() per deprecation timeline. 2025-01-15 22:28:37 +01:00
releases Refs #35060 -- Removed passing positional arguments to Model.save()/asave() per deprecation timeline. 2025-01-15 22:28:37 +01:00
topics Refs #35090 -- Removed support for django.urls.register_converter() overriding existing converters per deprecation timeline. 2025-01-15 22:28:37 +01:00
conf.py Bumped version; main is now 6.0 pre-alpha. 2025-01-15 22:28:37 +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 Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +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 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/