From da78f7755d1001289cebf0958c95a027f0b430c4 Mon Sep 17 00:00:00 2001 From: Felipe Prenholato Date: Thu, 7 May 2015 12:36:13 -0300 Subject: [PATCH] Move markdown to rst --- CHANGELOG.md => CHANGELOG.rst | 5 +++- README.md | 41 ------------------------------- README.rst | 46 +++++++++++++++++++++++++++++++++++ 3 files changed, 50 insertions(+), 42 deletions(-) rename CHANGELOG.md => CHANGELOG.rst (70%) delete mode 100644 README.md create mode 100644 README.rst diff --git a/CHANGELOG.md b/CHANGELOG.rst similarity index 70% rename from CHANGELOG.md rename to CHANGELOG.rst index 529da503..26ce2f00 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.rst @@ -1,3 +1,6 @@ -### 2014-05-07 ### + +---------- +2014-05-07 +---------- * Fix a bug in forms Fix a we refer field.widget.queryset instead field.queryset. diff --git a/README.md b/README.md deleted file mode 100644 index 44b96af3..00000000 --- a/README.md +++ /dev/null @@ -1,41 +0,0 @@ -djangocms-link -============== - -A Link plugin for django CMS. - - -Installation ------------- - -This plugin requires `django CMS` 3.0 or higher to be properly installed and -configured. If you have many pages it supports ajax loading for selecting a page. -To enable this install Django-Select2 3.1.2 or above. - -* In your projects `virtualenv`_, run ``pip install djangocms-link``. -* Add ``'djangocms_link'`` to your ``INSTALLED_APPS`` setting. -* If using Django 1.7 add ``'djangocms_link': 'djangocms_link.migrations_django',`` - to ``MIGRATION_MODULES`` (or define ``MIGRATION_MODULES`` if it does not exists); - when django CMS 3.1 will be released, migrations for Django 1.7 will be moved - to the standard location and the south-style ones to ``south_migrations``. -* Run ``manage.py migrate djangocms_link``. - -If you want to enable the ajax loading: - -* In your projects `virtualenv`_, run ``pip install Django-Select2``. -* Add ``'django_select2'`` to your ``INSTALLED_APPS`` settings. -* Add ``url(r'^select2/', include('django_select2.urls')),`` to your main ``urls.py``. - - -Children --------- - -This plugin supports child plugins. If you add an other plugin as a child it will take this content -instead of the link name as the content of the link. - -Translations ------------- - -If you want to help translate the plugin please do it on transifex: - -https://www.transifex.com/projects/p/django-cms/resource/djangocms-link/ - diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..77bef7f1 --- /dev/null +++ b/README.rst @@ -0,0 +1,46 @@ +|PyPI Version| |Build Status| |Coverage Status| + + +============== +djangocms-link +============== + +A Link plugin for django CMS. + + +Installation +~~~~~~~~~~~~ + + +This plugin requires :code:`django CMS` 3.0 or higher to be properly installed and +configured. If you have many pages it supports ajax loading for selecting a page. +To enable this install Django-Select2 3.1.2 or above. + +* In your projects :code:`virtualenv`, run :code:`pip install djangocms-link`. +* Add :code:`djangocms_link'` to your :code:`INSTALLED_APPS` setting. +* If using Django 1.7 add :code:`'djangocms_link': 'djangocms_link.migrations_django',` + to :code:`MIGRATION_MODULES` (or define `:code:`MIGRATION_MODULES`` if it does not exists); + when django CMS 3.1 will be released, migrations for Django 1.7 will be moved + to the standard location and the south-style ones to :code:`south_migrations`. +* Run ``manage.py migrate djangocms_link``. + +If you want to enable the ajax loading: + +* In your projects :code:`virtualenv`, run :code:`pip install Django-Select2`. +* Add :code:`'django_select2` to your :code:`INSTALLED_APPS` settings. +* Add :code:`url(r'^select2/, include('django_select2.urls')),` to your main ``urls.py``. + + +Children +~~~~~~~~ + +This plugin supports child plugins. If you add an other plugin as a child it will take this content +instead of the link name as the content of the link. + +Translations +~~~~~~~~~~~~ + +If you want to help translate the plugin please do it on transifex: + +https://www.transifex.com/projects/p/django-cms/resource/djangocms-link/ +