mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-27 19:46:22 +00:00
Code Issues 30 Releases Wiki Activity
5a82acbda8
django/docs
History
Adam Johnson 5a82acbda8 [4.2.x] Doc'd that Meta.indexes is preferred to Field.db_index. 
Backport of f9fe062de5 from main
2023-02-24 09:48:54 +01:00
..
_ext Refs #33476 -- Refactored code to strictly match 88 characters line length. 2022-02-07 20:37:05 +01:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
howto [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
internals [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
intro [4.2.x] Refs #34140 -- Applied rst code-block to non-Python examples. 2023-02-10 21:12:06 +01:00
man Updated man page for Django 4.2 alpha. 2023-01-17 08:51:17 +01:00
misc Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
ref [4.2.x] Doc'd that Meta.indexes is preferred to Field.db_index. 2023-02-24 09:48:54 +01:00
releases [4.2.x] Moved DatabaseIntrospection.get_table_description() internal_size release note to "Database backend API" section. 2023-02-22 05:18:03 +01:00
topics [4.2.x] Refs #32339 -- Doc'd BaseFormSet.as_div() 2023-02-15 09:24:59 +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] Fixed #34146 -- Added 3rd-party lib tutorial step. 2023-02-07 20:22:11 +01:00
make.bat Added spelling option to make.bat. 2021-04-30 14:04:22 +02:00
Makefile Fixed #33753 -- Fixed docs build on Sphinx 5+. 2022-06-01 12:13:15 +02:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
requirements.txt Bumped minimum Sphinx version to 4.5.0 in docs/requirements.txt. 2022-09-26 11:18:15 +02: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/