Commits

Artur Barseghyan  committed 5a098a6 Draft

better docs

  • Participants
  • Parent commits 378af18

Comments (0)

Files changed (5)

 An extensive example project is available at https://github.com/barseghyanartur/django-slim/tree/stable/example
 directory.
 
+Screenshots are present in documentation on PythonHosted (http://pythonhosted.org/django-slim/).
+
 Demo
 -----------------------------------
 In order to be able to quickly evaluate the django-slim, a demo app (with a quick installer) has been created

File builddocs.sh

+./uninstall.sh
 ./install.sh
-sphinx-build -n -a -b html docs builddocs
+sphinx-build -n -a -b html docs builddocs
+cd builddocs && zip -r ../builddocs.zip . -x ".*" && cd ..

File docs/index.rst

 An extensive example project is available at https://github.com/barseghyanartur/django-slim/tree/stable/example
 directory.
 
+Screenshots are present in documentation on PythonHosted (http://pythonhosted.org/django-slim/).
+
 Demo
 -----------------------------------
 In order to be able to quickly evaluate the django-slim, a demo app (with a quick installer) has been created
 
 See https://bitbucket.org/barseghyanartur/django-slim/src (example) directory for a working example.
 
-List view:
-
-.. image:: _static/list_view.png
-    :width: 960px
-    :align: center
-
-Edit view for main language:
-
-.. image:: _static/edit_view.png
-    :width: 960px
-    :align: center
-
-Edit view for translated item:
-
-.. image:: _static/edit_view_translated_item.png
-    :width: 960px
-    :align: center
-
 django-localeurl integration
 -----------------------------------
 Installation
 >>>     # Some more apps...
 >>> )
 
+License
+===================================
+GPL 2.0/LGPL 2.1
+
+Support
+===================================
+For any issues contact me at the e-mail given in the `Author` section.
+
+Author
+===================================
+Artur Barseghyan <artur.barseghyan@gmail.com>
+
 Documentation
 ===================================
+Screenshots
+-----------------------------------
+List view:
+
+.. image:: _static/list_view.png
+    :width: 960px
+    :align: center
+
+Edit view for main language:
+
+.. image:: _static/edit_view.png
+    :width: 960px
+    :align: center
+
+Edit view for translated item:
+
+.. image:: _static/edit_view_translated_item.png
+    :width: 960px
+    :align: center
 
 :mod:`models` Package
 --------------------
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
-License
-===================================
-GPL 2.0/LGPL 2.1
-
-Support
-===================================
-For any issues contact me at the e-mail given in the `Author` section.
-
-Author
-===================================
-Artur Barseghyan <artur.barseghyan@gmail.com>
     author_email = 'artur.barseghyan@gmail.com',
     package_dir = {'':'src'},
     packages = find_packages(where='./src'),
-    url = 'https://bitbucket.org/barseghyanartur/django-slim',
+    url = 'https://github.com/barseghyanartur/django-slim',
     license = 'GPL 2.0/LGPL 2.1',
     install_requires = install_requires
 )

File uninstall.sh

 rm dist -rf
 rm src/django_slim.egg-info -rf
 rm src/django-slim.egg-info -rf
+rm builddocs.zip