David Jean Louis avatar David Jean Louis committed 7c4c887

Switch to readthedocs.org for documentation + added a note on contributing to the docs

Comments (0)

Files changed (3)

 
 Django-admin-tools is generously documented, you can 
 `browse the documentation online 
-<http://packages.python.org/django-admin-tools/>`_.
+<http://django-admin-tools.readthedocs.org/>`_.
 a good start is to read `the quickstart guide 
-<http://packages.python.org/django-admin-tools/0.4.0/quickstart.html>`_.
+<http://django-admin-tools.readthedocs.org/quickstart.html>`_.
 
 Thanks for downloading django-admin-tools.

docs/contributing.rst

+.. _contributing:
+
+Contributing to django-admin-tools
+==================================
+
+You are very welcome to contribute to the project! django-admin-tools is
+hosted at `Bitbucket <http://www.bitbucket.org/izi/django-admin-tools/>`_,
+which makes collaborating very easy.
+
+There are various possibilities to get involved, for example you can:
+
+* `Report bugs <http://www.bitbucket.org/izi/django-admin-tools/issues/new/>`_,
+  preferably with patches if you can
+* `Discuss new features ideas 
+  <http://groups.google.fr/group/django-admin-tools>`_
+* `fork the project <http://www.bitbucket.org/izi/django-admin-tools/fork/>`_,
+  implement those features and send a pull request
+* Enhance the `documentation 
+  <http://www.bitbucket.org/izi/django-admin-tools/src/tip/docs/>`_
+* `Translate django-admin-tools 
+  <https://www.transifex.net/projects/p/django-admin-tools/c/admin_tools/>`_ 
+  in your language
  * a customizable menu bar,
  * tools to make admin theming easier.
 
-It was originally developed for django-cms, and then extracted to this
-pluggable app.
+.. note::
+    This documentation covers the latest version of django-admin-tools (tip).
+    For older versions please follow the links below:
+
+    * `Version 0.4.0 <http://readthedocs.org/docs/django-admin-tools/v0.4.0/>`_
+    * `Version 0.3.0 <http://readthedocs.org/docs/django-admin-tools/v0.3.0/>`_
+    * `Version 0.2.0 <http://readthedocs.org/docs/django-admin-tools/v0.2.0/>`_
+    * `Version 0.1.1 <http://readthedocs.org/docs/django-admin-tools/v0.1.1/>`_
+    * `Version 0.1.0 <http://readthedocs.org/docs/django-admin-tools/v0.1.0/>`_
 
 To get up and running quickly, consult the :ref:`quick-start guide
 <quickstart>`, which describes all the necessary steps to install
    menu
    dashboard
    integration
+   contributing
    testing
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.