mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity
669dcefc04
django/docs
History
mgaligniana 669dcefc04 Fixed #33338 -- Doc'd that never_cache() decorator set Expires header.
2021-12-13 15:34:19 +01:00
..
_ext Fixed crash building HTML docs since Sphinx 4.3. 2021-11-17 12:31:25 +01:00
_theme Fixed #32860 -- Made docs permalinks focusable to improve accessibility. 2021-06-21 13:47:26 +02:00
faq Refs #32074 -- Doc'd Python 3.10 compatibility in Django 3.2.x. 2021-10-05 13:30:41 +02:00
howto Used :source: role in docs/howto/custom-template-tags.txt. 2021-10-14 06:04:56 +02:00
internals Updated asgiref dependency for 4.0 release series. 2021-12-07 09:49:39 +01:00
intro Corrected module reference in contributing tutorial. 2021-11-03 07:47:27 +01:00
man Updated man page for Django 4.0 alpha. 2021-09-20 20:55:10 +02:00
misc Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
ref Fixed #33338 -- Doc'd that never_cache() decorator set Expires header. 2021-12-13 15:34:19 +01:00
releases Refs #32338 -- Added Boundfield.legend_tag(). 2021-12-09 07:16:33 +01:00
topics Fixed #33338 -- Doc'd that never_cache() decorator set Expires header. 2021-12-13 15:34:19 +01:00
conf.py Refs #33247 -- Used XeLaTeX for PDF docs build. 2021-11-12 09:36:18 +01:00
contents.txt
glossary.txt
index.txt Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
make.bat Added spelling option to make.bat. 2021-04-30 14:04:22 +02:00
Makefile
README.rst
requirements.txt Refs #33247 -- Corrected configuration for Read The Docs. 2021-11-03 18:35:27 +01:00
spelling_wordlist Added 'formatter' to spelling wordlist. 2021-10-12 15:16:00 +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/