mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-01 09:32:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
django/docs
History
Clifford Gama 9d93e35c20 Fixed #17461 -- Doc'd the presumed order of foreign keys on the intermediary model of a self-referential m2m. 
Thanks Giannis Terzopoulos and Sarah Boyce for the reviews.
2025-05-02 07:56:56 +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 Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:14:27 +01:00
howto Replaced '' with * for consistent emphasis styling in docs/howto/custom-template-tags.txt. 2025-04-15 14:48:55 -03:00
internals Fixed #36311 -- Unified spelling of "hardcode" and its variants in docs. 2025-04-15 14:48:55 -03:00
intro Fixed #18296 -- Created missing custom target directory for startproject and startapp. 2025-04-27 14:41:27 +01:00
man Americanized some spellings. 2025-04-16 10:21:38 +02:00
misc Fixed #35908 -- Retired the django-developers and django-users mailing lists. 2025-02-19 12:14:27 +01:00
ref Fixed #17461 -- Doc'd the presumed order of foreign keys on the intermediary model of a self-referential m2m. 2025-05-02 07:56:56 +01:00
releases Made cosmetic edits and added upcoming security release to release notes. 2025-04-30 14:55:12 -03:00
topics Fixed #17461 -- Doc'd the presumed order of foreign keys on the intermediary model of a self-referential m2m. 2025-05-02 07:56:56 +01:00
conf.py Fixed #36320 -- Ignored "duplicated_toc_entry" for ePub docs build. 2025-04-12 19:39:07 +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 Fixed #36162 -- Fixed the black Makefile docs rule to work on macOS. 2025-02-01 22:27:38 -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/