mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
Code Issues 25 Releases Wiki Activity
8d59075184
django/docs
History
Mariusz Felisiak 8d59075184 Refs #31224 -- Made sync_to_async() examples use thread sensitive with ORM calls.
2020-09-03 12:06:42 +02: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 Removed reference to unsupported versions of Django and Python. 2020-06-03 21:28:14 +02:00
howto Fixed #31912 -- Removed strict=True in Path.resolve() in project template and CommonPasswordValidator. 2020-08-28 05:57:36 +02:00
internals Fixed #31877 -- Reverted "Fixed #19878 -- Deprecated TemplateView passing URL kwargs into context." 2020-08-24 11:37:59 +02:00
intro Updated How to install Django on Windows guide. 2020-06-03 16:28:10 +02:00
man Updated man page for Django 3.1 alpha. 2020-05-12 11:26:37 +02:00
misc
ref Refs #11390 -- Clarified dual-calling of ChoiceField.choices callable. 2020-09-02 08:29:01 +02:00
releases Fixed #31941 -- Corrected FileField.deconstruct() with a callable storage. 2020-09-02 11:06:18 +02:00
topics Refs #31224 -- Made sync_to_async() examples use thread sensitive with ORM calls. 2020-09-03 12:06:42 +02:00
conf.py Bumped version; master is now 3.2 pre-alpha. 2020-05-13 09:07:51 +02:00
contents.txt
glossary.txt
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat
Makefile
README.rst
spelling_wordlist Fixed #31928 -- Fixed detecting an async get_response in various middlewares. 2020-08-28 12:33: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/