mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-24 13:44:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Carlton Gibson ec2af58ac6 [5.2.x] Doc'd how to use Intersphinx in the reusable apps tutorial. 
Backport of 6e54e20cc3 from main.
2025-03-27 17:36:21 +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 #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] Documented the updating of translation catalogs in post-release tasks. 2025-03-21 14:55:32 +01:00
intro [5.2.x] Doc'd how to use Intersphinx in the reusable apps tutorial. 2025-03-27 17:36:21 +01:00
man [5.2.x] Updated man page for Django 5.2 release candidate 1. 2025-03-19 09:03:25 +01: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] Updated ogrinfo output in GIS tutorial. 2025-03-23 21:36:33 +01:00
releases [5.2.x] Added stub release notes and release date for 5.1.8 and 5.0.14. 2025-03-26 09:03:04 +01:00
topics [5.2.x] Fixed typo in docs/topics/signals.txt. 2025-03-23 20:06:09 +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/