mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-04-15 21:04:36 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Salvo Polizzi c69dbc7c10 [5.0.x] Fixed #35069 -- Fixed typo in docs/ref/forms/api.txt. 
Backport of dc26a3d563b1e1d98d40f5d351a6a61c34f12d98 from main
2023-12-30 15:00:33 +01:00
..
_ext
Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+.
2023-08-03 08:01:06 +02:00
_theme
Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-05-31 11:17:01 +02:00
faq
[5.0.x] Updated examples for 2.0+ release numbering in installation FAQ.
2023-12-15 06:17:02 +01:00
howto
[5.0.x] Refs #34118 -- Doc'd Python 3.12 compatibility in Django 4.2.x.
2023-11-19 16:33:01 +01:00
internals
[5.0.x] Improved structure of Contributing Guide start page.
2023-11-30 09:32:34 +01:00
intro
[5.0.x] Corrected method/function wording in tutorial 3.
2023-12-29 06:01:47 +01:00
man
[5.0.x] Updated man page for Django 5.0 rc1.
2023-11-20 08:46:20 -03:00
misc
Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
ref
[5.0.x] Fixed #35069 -- Fixed typo in docs/ref/forms/api.txt.
2023-12-30 15:00:33 +01:00
releases
[5.0.x] Fixed #35056 -- Fixed system check crash on reverse m2m relations with related_name in ModelAdmin.filter_horizontal/vertical.
2023-12-27 20:37:23 +01:00
topics
[5.0.x] Fixed #35015 -- Updated MySQL notes in migrations topic.
2023-12-20 21:02:51 +01:00
conf.py
[5.0.x] Bumped django_next_version in docs config.
2023-09-18 11:28:22 -03:00
contents.txt
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
glossary.txt
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
index.txt
Added Django Forum to mailing lists page.
2023-03-24 08:32:17 +01:00
make.bat
Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:02:57 +01:00
Makefile
Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:02:57 +01: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
[5.0.x] Doc'd support for assistive technologies in the admin.
2023-11-17 11:20:54 +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/