django-admin2/docs
Andrews Medina 1d43c71829 Fix tests (#448)
* tox: disable development mode

* fix django-extra-views and djangorestframework versions

* using get_field instead get_field_by_name

to fix compatibility with Django 1.10

* travis: dont test Django 1.10 with Python 3.3
2016-11-13 11:47:08 +06: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 Fix tests (#448) 2016-11-13 11:47:08 +06:00
conf.py Convert readthedocs links for their .org -> .io migration for hosted projects 2016-06-08 04:07:57 +01:00
contributing.rst Convert readthedocs links for their .org -> .io migration for hosted projects 2016-06-08 04:07:57 +01:00
design.rst per #240, this adds indexing to the design document 2013-07-16 20:32:46 +02:00
faq.rst Work on contributing and the FAQ 2013-07-21 13:26:03 +02:00
index.rst Fix links to new home in the Jazzband. 2016-06-08 20:26:19 +02:00
installation.rst Fix documentation examples 2016-06-06 11:52:27 +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 fix typo 2014-06-19 08:59:56 +02: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:

* 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/