Commits

Artur Barseghyan committed c20e723 Draft

updated docs

Comments (0)

Files changed (2)

 
 Installation
 ======================
-1. Latest stable version on PyPI:
+1. Install in your virtual environemnt
+
+   Latest stable version from PyPI:
 
     $ pip install admin_timeline
 
-2. Latest development version:
+   Latest stable version from bitbucket:
+
+    $ pip install -e hg+http://bitbucket.org/barseghyanartur/django_admin_timeline@stable#egg=django_admin_timeline
+
+   Latest development version from bitbucket:
 
     $ pip install -e hg+http://bitbucket.org/barseghyanartur/django_admin_timeline#egg=django_admin_timeline
 
     >>> # ...
     >>> )
 
-4. Collect the static files by running:
+4. Collect the static files by running (see the Troubleshooting section in case of problems):
 
     $ ./manage.py collectstatic
 
     >>> (r'^admin/timeline/', include('admin_timeline.urls')),
     >>> url(r'^admin/', include(admin.site.urls)),
 
+Troubleshooting
+======================
+If somehow static files are not collected properly (missing admin_timeline.js and admin_timeline.css files), install
+the latest stable version from source.
+
+    $ pip install -e hg+http://bitbucket.org/barseghyanartur/django_admin_timeline@stable#egg=django_admin_timeline
+
 Usage
 ======================
 After following all installation steps, you should  be able to access the admin-timeline by:
 
 .. automodule:: admin_timeline.conf
     :members:
-    :undoc-members:
     :show-inheritance:
 
 :mod:`views` Module
 
 .. automodule:: admin_timeline.views
     :members:
-    :undoc-members:
     :show-inheritance:
 
 Indices and tables
 
 Installation
 ======================
-1. Latest stable version on PyPI:
+1. Install in your virtual environemnt
+
+   Latest stable version from PyPI:
 
     $ pip install admin_timeline
 
-2. Latest development version:
+   Latest stable version from bitbucket:
+
+    $ pip install -e hg+http://bitbucket.org/barseghyanartur/django_admin_timeline@stable#egg=django_admin_timeline
+
+   Latest development version from bitbucket:
 
     $ pip install -e hg+http://bitbucket.org/barseghyanartur/django_admin_timeline#egg=django_admin_timeline
 
     >>> # ...
     >>> )
 
-4. Collect the static files by running:
+4. Collect the static files by running (see the Troubleshooting section in case of problems):
 
     $ ./manage.py collectstatic
 
     >>> (r'^admin/timeline/', include('admin_timeline.urls')),
     >>> url(r'^admin/', include(admin.site.urls)),
 
+Troubleshooting
+======================
+If somehow static files are not collected properly (missing admin_timeline.js and admin_timeline.css files), install
+the latest stable version from source.
+
+    $ pip install -e hg+http://bitbucket.org/barseghyanartur/django_admin_timeline@stable#egg=django_admin_timeline
+
 Usage
 ======================
 After following all installation steps, you should  be able to access the admin-timeline by:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.