Tim Graham e645b79ef5 Added missing docs to DiscoverRunner for keepdb option; refs #20550. 10 år sedan
..
_ext fca677fa43 Added sphinx extension to ease generation of ticket links. 10 år sedan
_theme 6868643063 Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 10 år sedan
faq b9b8895acb Fixed #23527 -- Removed Cheetah references in docs 10 år sedan
howto 5c517ec218 Fixed versionchanged indentation in docs/. 10 år sedan
internals f2ddc439b1 Fixed #23656 -- Made FormMixin.get_form's form_class argument optional. 10 år sedan
intro dc241fdfdf Replaced dead links to python-distribute.org. 10 år sedan
man a0bfe4ea98 Replaced django-admin.py with django-admin in the man page. 10 år sedan
misc dd98ccd482 Fixed #16785 -- Documented some of the design decisions of the cache framework. 11 år sedan
ref 74e1980cf9 Fixed #13181 -- Added support for callable choices to forms.ChoiceField 10 år sedan
releases 74e1980cf9 Fixed #13181 -- Added support for callable choices to forms.ChoiceField 10 år sedan
topics e645b79ef5 Added missing docs to DiscoverRunner for keepdb option; refs #20550. 10 år sedan
Makefile a0f2525202 Fixed #22141 -- Added a spelling checker for documentation. 11 år sedan
README 37b13033c6 Removed sudo from pip commands in docs. 10 år sedan
conf.py 695956376f Removed simplejson inventory file from docs/conf.py. 10 år sedan
contents.txt 6eb4f25692 Removed an obsolete documentation page about admin style customization. 12 år sedan
glossary.txt babbf18999 Fixed some intersphinx references. 10 år sedan
index.txt d3db878e4b Moved CSRF docs out of contrib. 10 år sedan
make.bat 9b5f64cc6e Fixed #19516 - Fixed remaining broken links. 12 år sedan
spelling_wordlist 349471eeb9 Fixed spelling errors in docs. 10 år sedan

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/