mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-04-18 22:34:35 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
GabbyPrecious bbd1b3565b [3.2.x] Refs #32412 -- Adjusted beginning of Advice for new contributors. 
With the goal of guiding folks to the right destination:

* Improved wording of tutorial call-out.
* Added summary of page purpose.
* Added link to Writing code reference doc.

Backport of e733c9ac1746cedc78efabff340379f1c9ee47da from master
2021-02-04 10:37:15 +01:00
..
_ext
Made default_role_error use logger.
2020-06-03 11:42:42 +02:00
_theme
Fixed #16300 -- Improved singlehtml docs formatting with headers CSS.
2020-06-22 21:05:13 +02:00
faq
Refs #31040 -- Doc'd Python 3.9 compatibility.
2020-10-13 08:35:01 +02:00
howto
[3.2.x] Corrected versionadded annotations.
2021-01-19 11:58:37 +01:00
internals
[3.2.x] Refs #32412 -- Adjusted beginning of Advice for new contributors.
2021-02-04 10:37:15 +01:00
intro
[3.2.x] Fixed #32348, Refs #29087 -- Corrected tutorial for updated deleting inlines UI.
2021-01-27 08:47:27 +01:00
man
Updated django-admin man page for Django 3.2.
2021-01-14 14:58:28 +01:00
misc
Expanded API stability docs to include our policy of continual improvement.
2019-11-18 20:37:46 +01:00
ref
[3.2.x] Fixed typo in docs/ref/forms/widgets.txt.
2021-02-01 12:05:22 +01:00
releases
[3.2.x] Fixed typos in 3.2 release notes.
2021-02-04 09:56:58 +01:00
topics
[3.2.x] Modernized custom manager example
2021-01-28 16:01:46 +01:00
conf.py
Updated CVE URL.
2021-01-02 12:49:00 +01: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
Fixed #25712 -- Reorganized templates docs.
2020-04-30 08:12:09 +02:00
make.bat
Fixed #19516 - Fixed remaining broken links.
2013-01-02 18:32:57 -05:00
Makefile
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
spelling_wordlist
Fixed #32018 -- Extracted admin colors into CSS variables.
2021-01-07 10:07:19 +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/