mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-30 07:06:18 +01:00
Code Issues Releases Wiki Activity
97e637a87f
django/docs
History
luz.paz 97e637a87f Fixed typos in comments and docs.
2018-08-01 16:09:22 -04:00
..
_ext Bumped minimum Sphinx version to 1.6.0. 2018-03-22 20:30:03 -04:00
_theme Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
faq Fixed #29261 -- Doc'd the reason for LICENSE.python. 2018-06-29 20:00:58 -04:00
howto Removed parser.add_arguments() arguments that match the defaults. 2018-07-02 17:54:57 -04:00
internals Removed code terms from docs/spelling_wordlist. 2018-07-31 12:22:28 -04:00
intro Fixed typos in comments and docs. 2018-08-01 16:09:22 -04:00
man Updated man page for Django 2.1 alpha. 2018-05-17 09:30:20 -04:00
misc
ref Fixed typos in comments and docs. 2018-08-01 16:09:22 -04:00
releases Added stub release notes for 2.1.1. 2018-08-01 11:13:37 -04:00
topics Removed code terms from docs/spelling_wordlist. 2018-07-31 12:22:28 -04:00
conf.py Bumped version to 2.2 in docs. 2018-05-17 20:48:45 -04:00
contents.txt
glossary.txt
index.txt Fixed #28594 -- Removed Jython docs and specific code 2017-12-23 10:26:32 +01:00
make.bat
Makefile
README
spelling_wordlist Fixed typos in comments and docs. 2018-08-01 16:09:22 -04: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 ``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/