mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-27 11:35:53 +00:00
Code Issues 30 Releases Wiki Activity
42b362e081
django/docs
History
Mariusz Felisiak 42b362e081 [4.2.x] Updated release process for 2.0+ release numbering and latest practices. 
Backport of 073b5fd400 from main
2023-04-04 07:28:42 +02:00
..
_ext
_theme
faq [4.2.x] Fixed #34140 -- Reformatted code blocks in docs with blacken-docs. 2023-03-01 13:39:03 +01:00
howto [4.2.x] Doc'd use of asgiref.sync adapters with sensitive variables. 2023-03-22 16:24:56 +01:00
internals [4.2.x] Updated release process for 2.0+ release numbering and latest practices. 2023-04-04 07:28:42 +02:00
intro [4.2.x] Fixed #34140 -- Reformatted code blocks in docs with blacken-docs. 2023-03-01 13:39:03 +01:00
man [4.2.x] Updated man page for Django 4.2 final. 2023-04-03 08:56:48 +02:00
misc
ref [4.2.x] Fixed #34431 -- Improved Date/DateTimeField/TimeField.input_formats docs. 2023-04-03 08:15:10 +02:00
releases [4.2.x] Added stub release notes for 4.2.1. 2023-04-03 11:20:47 +02:00
topics [4.2.x] Fixed #34409 -- Doc'd limitation of dictfetchall() and namedtuplefetchall() examples. 2023-03-22 19:23:26 +01:00
conf.py [4.2.x] Bumped django_next_version in docs config. 2023-01-17 08:54:30 +01:00
contents.txt
glossary.txt
index.txt [4.2.x] Added Django Forum to mailing lists page. 2023-03-24 08:58:45 +01:00
make.bat [4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:34:28 +01:00
Makefile [4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:34:28 +01:00
README.rst
requirements.txt [4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:34:28 +01:00
spelling_wordlist [4.2.x] Fixed #34146 -- Added 3rd-party lib tutorial step. 2023-02-07 20:22:11 +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/