mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-13 15:28:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Grammy Jiang 6661c48a20 [4.0.x] Updated OWASP Top 10 link in security topic. 
Backport of ef9121f3e6 from main
2022-06-16 06:36:21 +02:00
..
_ext [4.0.x] Refs #33476 -- Refactored code to strictly match 88 characters line length. 2022-02-08 19:25:02 +01:00
_theme
faq [4.0.x] Added backticks to code literals in various docs. 2022-04-28 11:17:57 +02:00
howto [4.0.x] Added backticks to code literals in various docs. 2022-04-28 11:17:57 +02:00
internals [4.0.x] Updated various links to HTTPS and new locations. 2022-03-29 07:46:55 +02:00
intro [4.0.x] Updated various links to HTTPS and new locations. 2022-03-29 07:46:55 +02: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 [4.0.x] Unified AdminSite imports in docs. 2022-05-25 13:14:30 +02:00
releases [4.0.x] Added stub release notes for 4.0.6. 2022-06-01 14:40:58 +02:00
topics [4.0.x] Updated OWASP Top 10 link in security topic. 2022-06-16 06:36:21 +02:00
conf.py [4.0.x] Bumped minimum Sphinx version to 4.5.0. 2022-05-31 15:24:47 +02: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
Makefile [4.0.x] Fixed #33753 -- Fixed docs build on Sphinx 5+. 2022-06-01 12:15:06 +02:00
README.rst
requirements.txt [4.0.x] Refs #33247 -- Corrected configuration for Read The Docs. 2021-11-03 18:46:08 +01:00
spelling_wordlist [4.0.x] Fixed #33725 -- Made hidden quick filter in admin's navigation sidebar not focusable. 2022-05-21 14:38:53 +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/