Commits

Chris Moffitt committed 052dd96

Clarifying the difference between docutils and sphinx for documentation.

  • Participants
  • Parent commits 60d6bbb

Comments (0)

Files changed (2)

File docs/new_installation.txt

        cd /path/to/your/site-packages/dir
        ln -s /path/to/django-signals-ahoy/signals_ahoy
 
-8. Optional dependencies::
+Satchmo has two types of documentation. Sphinx is used to generate this document.
+Docutils are useful for the auto-generated admin documentation. You may choose to
+install these dependencies.
+
+8. Optional documentation dependencies::
 
     easy_install Sphinx
+    easy_install docutils
     
 .. note::
     Please note that all dependencies can be installed manually. Please visit the requirements_ page for details. Also, provided egg and tar files may not be the most current installation, so you should ensure that the

File docs/requirements.txt

 
     - `PyYaml`_
 
-Sphinx is useful for auto generating some documentation but is not required:
+Docutils is used for auto generating the admin documentation but is not required:
+    
+    - `Docutils`_
+
+Sphinx is useful for auto generating the user documentation but is not required:
 
     - `Sphinx`_
 
 .. _`Sorl Thumbnails`: http://code.google.com/p/sorl-thumbnail/
 .. _`SSL Backport`: http://pypi.python.org/pypi/ssl/
 .. _`Signals Ahoy`: http://bitbucket.org/bkroeze/django-signals-ahoy/
+.. _DocUtils: http://docutils.sourceforge.net/