Documentation updates, indexed documentation

apps/common/forms.py

@@ -161,7 +161,7 @@ class FileDisplayForm(forms.Form):
 
     def __init__(self, *args, **kwargs):
         super(FileDisplayForm, self).__init__(*args, **kwargs)
-        changelog_path = os.path.join(settings.PROJECT_ROOT, self.DIRECTORY, self.FILENAME)
+        changelog_path = os.path.join(settings.PROJECT_ROOT, os.sep.join(self.DIRECTORY), self.FILENAME)
         fd = open(changelog_path)
         self.fields['text'].initial = fd.read()
         fd.close()
@@ -169,4 +169,4 @@ class FileDisplayForm(forms.Form):
 
 class LicenseForm(FileDisplayForm):
     FILENAME = u'LICENSE'
-    DIRECTORY = u'docs'
+    DIRECTORY = [u'docs', u'credits']

docs/conf.py

@@ -40,7 +40,8 @@ source_suffix = '.rst'
 #source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+#master_doc = 'index'
+master_doc = 'contents'
 
 # General information about the project.
 project = u'Mayan EDMS'

docs/contents.rst

@@ -0,0 +1,22 @@
+.. _contents:
+
+=================================
+Mayan EDMS documentation contents
+=================================
+
+.. toctree::
+    :hidden:
+
+    index
+
+.. toctree::
+    :maxdepth: 3
+
+    intro/index
+    topics/index
+    releases/index
+    topics/settings
+    topics/development
+    credits/index
+    faq/index
+    

docs/credits/index.rst

@@ -0,0 +1,11 @@
+Credits
+=======
+
+Introductions to all the key parts of Mayan EDMS you'll need to know:
+
+.. toctree::
+   :maxdepth: 1
+
+   contributors
+   software_used
+   license

docs/faq/index.rst

@@ -20,7 +20,7 @@ before trying again.
 
 
 Q: _mysql_exceptions. OperationalError: (1267, "Illegal mix of collations (latin1_swedish_ci, IMPLICIT) and (utf8_general_ci, COERCIBLE) for operation '='")
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 * Solution::
 
@@ -126,7 +126,7 @@ Q: How do you upload a new version of an existing file?
     version number and comments for the new version being uploaded.
 
 Q: Site search is slow
-~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~
 
 * Add indexes to the following fields:
   
@@ -250,7 +250,7 @@ http://stackoverflow.com/questions/6493985/django-auth-ldap
 
 
 Q:  Can you change the display order of documents...i.e can they be in alphabetical order?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 A the moment no, but it is something being considered.
 

docs/index.rst

@@ -24,6 +24,7 @@ On the Web
 * Source: http://github.com/rosarior/mayan
 * Video: http://bit.ly/Mayan-Intro
 
+Looking for specific information? Try the :doc:`detailed table of contents <contents>` otherwise below are the different part of the documentation.
 
 First steps
 ===========
@@ -69,9 +70,9 @@ For developers
 Credits
 =======
 
-  :doc:`Contributors <topics/contributors>` |
-  :doc:`Software used <topics/software_used>` |
-  :doc:`Licensing <license>`
+  :doc:`Contributors <credits/contributors>` |
+  :doc:`Software used <credits/software_used>` |
+  :doc:`Licensing <credits/license>`
     
 
 Getting help

docs/intro/index.rst

@@ -0,0 +1,33 @@
+Getting started
+===============
+
+New to Mayan EDMS?  Read this material to quickly get up and running.
+
+.. toctree::
+   :maxdepth: 1
+   
+   overview
+   features
+   requirements
+   installation
+   
+   
+.. seealso::
+
+    If you're new to Python_, you might want to start by getting an idea of what
+    the language is like. Mayan EDMS is 100% Python, so if you've got minimal
+    comfort with Python you'll probably get a lot more out of Mayan EDMS.
+    
+    If you're new to programming entirely, you might want to start with this
+    `list of Python resources for non-programmers`_
+    
+    If you already know a few other languages and want to get up to speed with
+    Python quickly, we recommend `Dive Into Python`_ (also available in a
+    `dead-tree version`_). If that's not quite your style, there are quite
+    a few other `books about Python`_.
+    
+    .. _python: http://python.org/
+    .. _list of Python resources for non-programmers: http://wiki.python.org/moin/BeginnersGuide/NonProgrammers
+    .. _dive into python: http://diveintopython.net/
+    .. _dead-tree version: http://www.amazon.com/exec/obidos/ASIN/1590593561/ref=nosim/jacobian20
+    .. _books about Python: http://wiki.python.org/moin/PythonBooks

docs/releases/0.11.rst

@@ -21,12 +21,14 @@ Version 0.11
   filename field, filename are store as uploaded not manipulation is done
   Users with existing data must install South and run the appropiate
   migrate commands::
+  
     $ pip install -r requirements/production.txt
     $ ./manager syncdb
     $ ./manage.py migrate documents 0001 --fake
     $ ./manage.py migrate documents
+
 * Added new office document mimetype
-    * application/vnd.ms-office
+  * application/vnd.ms-office
 * Fixed documents not saving the file encoding
 * Removed extra slash in ajax-loader.gif URL fixes #15, thanks to 
   IHLeanne for finding this one

docs/releases/index.rst

@@ -15,7 +15,7 @@ Final releases
 ==============
 
 0.12 release
------------
+------------
 .. toctree::
    :maxdepth: 1
 

docs/topics/index.rst

@@ -0,0 +1,15 @@
+Using Mayan EDMS
+================
+
+Introductions to all the key parts of Mayan EDMS you'll need to know:
+
+.. toctree::
+   :maxdepth: 1
+
+   indexes
+   smart_links
+   permissions
+   document_visualization
+   ocr
+   file_storage
+   transformations