Merge branch 'feature/review-docs' into develop

Author: Fantomas42

docs/conf.py

@@ -22,7 +22,11 @@
 sys.path.append(os.path.join(HERE, '..'))
 
 import tagging
+import sphinx_rtd_theme
 
+html_theme = "sphinx_rtd_theme"
+
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -117,7 +121,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+#html_theme = 'default'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/index.rst

@@ -8,16 +8,9 @@ retrieval of tags simple.
 
 .. _`Django`: http://www.djangoproject.com
 
-.. toctree::
-   :maxdepth: 3
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
+.. contents::
+    :local:
+    :depth: 3
 
 Installation
 ============
@@ -31,21 +24,16 @@ https://pypi.python.org/pypi/django-tagging/
 Source distribution
 ~~~~~~~~~~~~~~~~~~~
 
-Download the .zip distribution file and unpack it. Inside is a script
+Download the a distribution file and unpack it. Inside is a script
 named ``setup.py``. Enter this command::
 
-   python setup.py install
+  $ python setup.py install
 
 ...and the package will install automatically.
 
-Windows installer
-~~~~~~~~~~~~~~~~~
-
-A Windows installer is also made available - download the .exe
-distribution file and launch it to install the application.
+More easily with :program:`pip`::
 
-An uninstaller will also be created, accessible through Add/Remove
-Programs in your Control Panel.
+  $ pip install django-tagging
 
 Installing the development version
 ----------------------------------
@@ -66,8 +54,8 @@ You can verify that the application is available on your PYTHONPATH by
 opening a Python interpreter and entering the following commands::
 
    >>> import tagging
-   >>> tagging.VERSION
-   (0, 3, 4, 'final', 0)
+   >>> tagging.__version__
+   0.4.dev0
 
 When you want to update your copy of the Django Tagging source code, run
 the command ``git pull`` from within the ``django-tagging`` directory.
@@ -91,14 +79,13 @@ Once you've installed Django Tagging and want to use it in your Django
 applications, do the following:
 
    1. Put ``'tagging'`` in your ``INSTALLED_APPS`` setting.
-   2. Run the command ``manage.py syncdb``.
+   2. Run the command ``manage.py migrate``.
 
-The ``syncdb`` command creates the necessary database tables and
+The ``migrate`` command creates the necessary database tables and
 creates permission objects for all installed apps that need them.
 
 That's it!
 
-
 Settings
 ========