mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-03-27 17:50:46 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
David Smith bd766ac8bf [3.1.x] Fixed #31628 -- Updated Windows install guide to recommend venv. 
Backport of 922ff51f5ac34205f454d7b5786cef57f32b6ca3 from master
2020-05-27 11:20:13 +02:00
..
_ext
Changed '%s' % value pattern to str(value).
2020-05-04 08:27:18 +02:00
_theme
Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags.
2019-12-11 09:49:54 +01:00
faq
[3.1.x] Used :envvar: role and .. envvar:: directive in various docs.
2020-05-13 09:38:59 +02:00
howto
[3.1.x] Fixed #31628 -- Updated Windows install guide to recommend venv.
2020-05-27 11:20:13 +02:00
internals
[3.1.x] Added notes related to security pre-notification list requests.
2020-05-21 10:31:29 +02:00
intro
[3.1.x] Fixed #31628 -- Updated Windows install guide to recommend venv.
2020-05-27 11:20:13 +02:00
man
Updated man page for Django 3.1 alpha.
2020-05-12 11:26:37 +02:00
misc
Expanded API stability docs to include our policy of continual improvement.
2019-11-18 20:37:46 +01:00
ref
[3.1.x] Refs #31615 -- Improved creating extension docs.
2020-05-27 11:14:31 +02:00
releases
[3.1.x] Updated expected release dates for 3.0.7 and 2.2.13.
2020-05-27 10:20:37 +02:00
topics
[3.1.x] Fixed some formatting issues in docs.
2020-05-27 09:07:33 +02:00
conf.py
[3.1.x] Bumped django_next_version in docs config.
2020-05-12 11:40:57 +02:00
contents.txt
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
glossary.txt
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
index.txt
Fixed #25712 -- Reorganized templates docs.
2020-04-30 08:12:09 +02:00
make.bat
…
Makefile
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
spelling_wordlist
[3.1.x] Added Kyrgyz language.
2020-05-20 12:30:18 +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/