mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-27 03:25:58 +00:00
Code Issues 30 Releases Wiki Activity
45fae65672
django/docs
History
duranbe b2601a77f9 [5.0.x] Fixed #34971 -- Doc'd additional loggers. 
Co-authored-by: duranbe <benoit.durand.mail@gmail.com>
Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>

Backport of 0450c9bdf1 from main
2024-01-24 08:48:17 -03: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] Fixed tutorial 'background.gif' reference. 2024-01-22 05:26:15 +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 #34971 -- Doc'd additional loggers. 2024-01-24 08:48:17 -03:00
releases [5.0.x] Fixed #35127 -- Made Model.full_clean() ignore GeneratedFields. 2024-01-19 08:56:14 +01:00
topics [5.0.x] Fixed typo in docs/topics/auth/default.txt. 2024-01-22 17:43:46 +01:00
conf.py [5.0.x] Bumped django_next_version in docs config. 2023-09-18 11:28:22 -03:00
contents.txt
glossary.txt
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/