Working on Sphinx docs

2014-08-20 20:47:13 -04:00
parent 5a93437f11
commit 279ce2e71f
46 changed files with 15155 additions and 0 deletions
@@ -0,0 +1,23 @@
+.. Django Admin Sortable documentation master file, created by
+   sphinx-quickstart on Wed Aug 20 14:40:56 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Django Admin Sortable's documentation!
+=================================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   quickstart
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
@@ -0,0 +1,10 @@
+Quickstart
+==========
+
+To get started using ``django-admin-sortable`` simply install it using ``pip``::
+
+    $ pip install django-admin-sortable
+
+Add ``adminsortable`` to your project's ``INSTALLED_APPS`` setting.
+
+Ensure ``django.core.context_processors.static`` is in your ``TEMPLATE_CONTEXT_PROCESSORS`` setting.