1
0
mirror of https://github.com/django/django.git synced 2024-11-18 07:26:04 +00:00
django/docs
Kostochko Dmitriy 13409b932a Updated links in admin docs to use :ref:
per Sphinx docs: "Using ref is advised over standard reStructuredText
links to sections because it works across files, when section headings
are changed, and for all builders that support cross-references.
2014-10-06 10:46:16 -04:00
..
_ext Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
_theme Added newlines to the ends of CSS, HTML, and JavaScript files missing them. 2014-08-12 19:22:09 -04:00
faq Fixed #23527 -- Removed Cheetah references in docs 2014-09-21 18:03:31 +02:00
howto Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
internals Added my bio to team.txt 2014-09-24 22:45:03 -04:00
intro Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
man Replaced django-admin.py with django-admin in the man page. 2014-07-31 23:46:49 +02:00
misc
ref Updated links in admin docs to use :ref: 2014-10-06 10:46:16 -04:00
releases Fixed #23601 -- Ensured view exists in URLconf before importing it in admindocs. 2014-10-06 09:31:39 -04:00
topics Fixed #23597 -- Clarified the manager that {Single,Multiple}ObjectMixin.model uses. 2014-10-06 08:23:42 -04:00
conf.py Added sphinx extension to ease generation of ticket links. 2014-08-19 17:40:50 -04:00
contents.txt
glossary.txt Fixed #23281 -- Added "concrete model" to glossary. 2014-09-08 08:45:47 -04:00
index.txt Fixed #17101 -- Integrated django-secure and added check --deploy option 2014-09-12 15:05:23 -04:00
make.bat
Makefile
README Removed sudo from pip commands in docs. 2014-09-22 15:49:48 -04:00
spelling_wordlist Updated docs/spelling_wordlist 2014-10-02 11:52:05 +01:00

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/