mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-24 05:36:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
David Smith fc0e0876da [3.0.x] Refs #27778 -- Removed reference to ASCII usernames in django.contrib.auth.models.User docs. 
Backport of 505b7b6163 from master
2020-05-01 06:11:58 +02:00
..
_ext [3.0.x] Fixed CodeBlock deprecation warning on Sphinx 2.1+. 2020-04-07 09:49:36 +02:00
_theme
faq [3.0.x] Prevented (and corrected) single backtick usage in docs. 2020-04-01 15:15:21 +02:00
howto [3.0.x] Prevented (and corrected) single backtick usage in docs. 2020-04-01 15:15:21 +02:00
internals [3.0.x] Refs #22463 -- Replaced JSHint with ESLint in contributing docs. 2020-04-20 10:53:53 +02:00
intro [3.0.x] Fixed typo in docs/intro/contributing.txt. 2020-04-24 08:18:37 +02:00
man [3.0.x] Updated man page for Django 3.0 release candidate 1. 2019-11-18 09:27:41 +01:00
misc [3.0.x] Expanded API stability docs to include our policy of continual improvement. 2019-11-18 21:39:30 +01:00
ref [3.0.x] Refs #27778 -- Removed reference to ASCII usernames in django.contrib.auth.models.User docs. 2020-05-01 06:11:58 +02:00
releases [3.0.x] Updated expected date for 3.0.6 release. 2020-04-28 10:13:23 +02:00
topics [3.0.x] Fixed broken links in docs. 2020-04-28 10:10:15 +02:00
conf.py [3.0.x] Prevented (and corrected) single backtick usage in docs. 2020-04-01 15:15:21 +02:00
contents.txt
glossary.txt
index.txt [3.0.x] Rewrote Get Help FAQ. 2020-03-26 10:25:24 +01:00
make.bat
Makefile
README [3.0.x] Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:06:23 +01:00
spelling_wordlist [3.0.x] Corrected docs spelling of PgBouncer. 2020-04-01 15:15:21 +02:00

README 

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
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.

[1] http://docutils.sourceforge.net/rst.html
[2] https://www.sphinx-doc.org/