mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity
7d44aeb388
django/docs
History
Gabriel Augendre 307c63f9a7 Fixed #30780 -- Improved visibility of Getting Help FAQ in tutorials.
2019-12-31 08:54:26 +01:00
..
_ext Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+. 2019-11-25 10:33:33 +01:00
_theme Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags. 2019-12-11 09:49:54 +01:00
faq Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin. 2019-12-06 12:11:44 +01:00
howto Refs #30767 -- Improved deployment documentation. 2019-12-20 10:42:56 +01:00
internals Added guidelines for assertIs() usage. 2019-12-30 11:25:18 +01:00
intro Fixed #30780 -- Improved visibility of Getting Help FAQ in tutorials. 2019-12-31 08:54:26 +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 #30892 -- Fixed slugify() and admin's URLify.js for "İ". 2019-12-30 20:47:22 +01:00
releases Fixed #30819 -- Fixed year determination in admin calendar widget for two-digit years. 2019-12-30 13:06:29 +01:00
topics Removed unnecessary code-block directives in various docs. 2019-12-23 14:47:13 +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 Refs #30780 -- Moved "First steps" section to the top of index page. 2019-12-31 08:14:45 +01:00
make.bat
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00
spelling_wordlist Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable. 2019-12-03 17:29:31 +01: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] http://sphinx-doc.org/