1
0
mirror of https://github.com/django/django.git synced 2024-12-23 09:36:06 +00:00
django/docs
2019-11-29 08:23:01 +01:00
..
_ext Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+. 2019-11-25 10:33:33 +01:00
_theme
faq Fixed #31018 -- Removed django-nonrel in NoSQL databases FAQ. 2019-11-27 07:36:20 +01:00
howto Fixed #30999 -- Fixed typo in docs/howto/custom-template-tags.txt. 2019-11-19 10:08:32 +01:00
internals Refs #31029 -- Added note about :rfc: role in writing documentation docs. 2019-11-27 20:52:28 +01:00
intro Fixed #29983 -- Replaced os.path() with pathlib.Path in project template and docs. 2019-11-07 11:11:27 +01:00
man Updated man page for 3.0 alpha release. 2019-09-10 10:10:50 +02:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Fixed #31029 -- Used more specific links to RFCs. 2019-11-27 20:54:38 +01:00
releases Fixed #31021 -- Fixed proxy model permissions data migration crash with a multiple databases setup. 2019-11-29 08:23:01 +01:00
topics Used 🎫 role in all tickets links. 2019-11-26 14:02:24 +01:00
conf.py Bumped version; master is now 3.1 pre-alpha. 2019-09-10 11:54:25 +02:00
contents.txt
glossary.txt
index.txt Fixed #30767 -- Improved references to deployment documentation. 2019-09-09 10:02:33 +02:00
make.bat
Makefile
README
spelling_wordlist

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] http://sphinx-doc.org/