Hopiu/django-admin2
1
0
Fork 0
mirror of https://github.com/jazzband/django-admin2.git synced 2026-03-17 06:30:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
django-admin2/docs
History
Daniel Greenfeld 77e1e994b2 Add design to contributing
2013-05-20 10:37:29 +02:00
..
api.rst Adding a quick hint to the API in the documentation. 2013-05-19 14:19:58 +02:00
architecture.rst architecture thoughts 2013-05-20 10:33:31 +02:00
conf.py merge 2013-05-18 16:32:22 +02:00
contributing.rst Add design to contributing 2013-05-20 10:37:29 +02:00
design.rst architecture thoughts 2013-05-20 10:33:31 +02:00
index.rst architecture thoughts 2013-05-20 10:33:31 +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
meta.rst merge 2013-05-18 16:32:22 +02:00
README merge 2013-05-18 16:32:22 +02:00
themes.rst Write theming docs. Close issue #89. 2013-05-19 14:51:43 +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:

* Install Sphinx (using ``sudo 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.pocoo.org/