Home Explore Help
Sign In
CityApper
/
django
mirror of https://github.com/django/django
2
0
Fork 0
Files Issues 0 Wiki
Tree: dc2d75f4d4
Branches Tags
django
/
docs
Tim Graham dc2d75f4d4 Fixed typo in aggregation docs link. 10 years ago
..
_ext fca677fa43 Added sphinx extension to ease generation of ticket links. 10 years ago
_theme 6868643063 Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 10 years ago
faq ecf7814b3a Added 1.9/removed 1.5 on Python version support table. 10 years ago
howto 560b4207b1 Removed redundant numbered parameters from str.format(). 10 years ago
internals 82e4f956e3 Fixed #23289 -- Added mock as a test dependency. 10 years ago
intro 560b4207b1 Removed redundant numbered parameters from str.format(). 10 years ago
man d63703f1cd Fixed #18714 -- Added 'fuzzy' compilemessages option 10 years ago
misc dd98ccd482 Fixed #16785 -- Documented some of the design decisions of the cache framework. 11 years ago
ref 49d034fff2 Fixed typo in docs/ref/request-response.txt. 10 years ago
releases b06dfad88f Fixed #23939 -- Moved session verification out of SessionAuthenticationMiddleware. 10 years ago
topics dc2d75f4d4 Fixed typo in aggregation docs link. 10 years ago
Makefile a0f2525202 Fixed #22141 -- Added a spelling checker for documentation. 11 years ago
README 37b13033c6 Removed sudo from pip commands in docs. 10 years ago
conf.py 6302893112 Updated formtools docs to point at new package outside the Django repo. 10 years ago
contents.txt 6eb4f25692 Removed an obsolete documentation page about admin style customization. 12 years ago
glossary.txt babbf18999 Fixed some intersphinx references. 10 years ago
index.txt 6302893112 Updated formtools docs to point at new package outside the Django repo. 10 years ago
make.bat 9b5f64cc6e Fixed #19516 - Fixed remaining broken links. 12 years ago
spelling_wordlist 8bb9e7c999 Fixed spelling in docs/ref/django-admin.txt. 10 years ago

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/