mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-28 03:55:50 +00:00
Code Issues 30 Releases Wiki Activity
8c88ae8251
django/docs
History
Markus Amalthea Magnuson 8c88ae8251 [5.0.x] Fixed #34970 -- Clarified Password Validation docs regarding the password_changed callback. 
Backport of 61c305f298 from main
2023-11-15 21:52:11 -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 Fixed #34545 -- Corrected the number of months in installation FAQ. 2023-05-08 08:34:23 +02:00
howto [5.0.x] Removed obsolete sentence in custom model field docs. 2023-11-15 13:49:17 +01:00
internals [5.0.x] Restructured writing documentation contributing guide. 2023-10-21 16:56:16 +02:00
intro [5.0.x] Reorganized tutorial's part 4 to better understand changes needed in URLConf. 2023-10-10 14:05:36 -03:00
man Updated man page for Django 5.0 alpha. 2023-09-18 09:25:34 -03:00
misc
ref [5.0.x] Refs #33690 -- Added missing data-theme selector to example in theming support docs. 2023-11-15 05:27:51 +01:00
releases [5.0.x] Fixed #34944 -- Made GeneratedField.output_field required. 2023-11-14 20:22:33 +01:00
topics [5.0.x] Fixed #34970 -- Clarified Password Validation docs regarding the password_changed callback. 2023-11-15 21:52:11 -03: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
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Added Uyghur language. 2023-08-12 20:37:15 +02: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/