django-admin2

mirror of https://github.com/jazzband/django-admin2.git synced 2026-03-17 06:30:25 +00:00

History

Danilo Bargen b2f4290bf2 Documentation		2013-07-07 15:08:42 +02:00
..
_ext	Make django docs intersphinx work	2013-07-06 13:50:21 +02:00
_static	Better translation docs	2013-07-06 16:21:44 +02:00
ref	Documentation	2013-07-07 15:08:42 +02:00
conf.py	Fixed intersphinx objects reference for Django	2013-07-06 13:59:16 +02:00
contributing.rst	Simpler way to pull upstream changes, with optional rebase for advanced git users.	2013-07-06 09:55:06 +02:00
design.rst	Add performance goal to docs	2013-06-09 20:21:35 +02:00
index.rst	Documentation	2013-07-07 15:08:42 +02:00
installation.rst	Typo: `:docs:` should be `:doc`	2013-07-06 12:23:36 +02:00
internationalization.rst	Reference to gettext docs	2013-07-06 16:38:24 +02:00
make.bat	Basic sphinx documentation layout.	2013-05-18 13:00:51 +02:00
Makefile	Basic sphinx documentation layout.	2013-05-18 13:00:51 +02:00
README	Setting up autodoc for the docs.	2013-05-29 10:44:22 +02:00
tutorial.rst	Adding to the reference	2013-05-22 17:37:02 +02: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:

* Create a virtualenv and activate it.

* Install all dependencies from requirements.txt inot the virtualenv using
  ``pip install -r requirements.txt`` (this will also install Sphinx).

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) at a shell prompt while the virtualenv is active.

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.pocoo.org/