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
Lily Foote 817ed81aea [5.2.x] Updated guidance to propose new feature ideas in contributing docs. 
These changes include:
* Clarification of the new feature proposal and evaluation process.
* Reodering "points to consider" into reporting bugs section, since
  these are mostly trac-specific.
* Narrowing the guide on user interface bugs and features to just bugs.
* Updating documentation for Someday/Maybe triage stage.

Co-authored-by: Tim Schilling <schilling711@gmail.com>
Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com>
Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>

Backport of 188799e67c from main.
2025-05-13 21:40:21 -03: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 [5.2.x] Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:16:20 +01:00
howto [5.2.x] Fixed #36252 -- Handled duplicate automatic imports in the shell command. 2025-03-17 16:30:31 -03:00
internals [5.2.x] Updated guidance to propose new feature ideas in contributing docs. 2025-05-13 21:40:21 -03:00
intro [5.2.x] Updated guidance to propose new feature ideas in contributing docs. 2025-05-13 21:40:21 -03:00
man [5.2.x] Updated man page for Django 5.2 final. 2025-04-02 14:47:20 +02:00
misc [5.2.x] Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:16:20 +01:00
ref [5.2.x] Fixed #17461 -- Doc'd the presumed order of foreign keys on the intermediary model of a self-referential m2m. 2025-05-02 09:02:16 +02:00
releases [5.2.x] Fixed #36373 -- Fixed select_related() crash on foreign object for a composite pk. 2025-05-12 13:34:45 +02:00
topics [5.2.x] Fixed #17461 -- Doc'd the presumed order of foreign keys on the intermediary model of a self-referential m2m. 2025-05-02 09:02:16 +02:00
conf.py [5.2.x] Fixed #36320 -- Ignored "duplicated_toc_entry" for ePub docs build. 2025-04-12 19:39:32 +02: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/