Skip to content

Commit

Permalink
Adding release notes for version 3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Iago Veloso committed Jun 9, 2017
1 parent 7365633 commit 321cbbc
Show file tree
Hide file tree
Showing 11 changed files with 156 additions and 10 deletions.
15 changes: 15 additions & 0 deletions docs/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,18 @@ Finally, there is a endpoint to get the current transmission:
http://127.0.0.1:8000/api/2/transmissions/now
************
Radiocom API
************
*New in version 3.1*

`Radiocom <https://github.com/ficiverson/radiocom-android>`_ is an Android application for Community Media Stations.
RadioCo has the `Radiocom API <https://github.com/ficiverson/radiocom-android>`_ under the following urls:

.. code-block:: bash
http://127.0.0.1:8000/api/2/radiocom/programmes
http://127.0.0.1:8000/api/2/radiocom/radiostation
http://127.0.0.1:8000/api/2/radiocom/transmissions
http://127.0.0.1:8000/api/2/radiocom/transmissions/now
8 changes: 0 additions & 8 deletions docs/source/source_code/radioco.apps.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,6 @@ Subpackages
Submodules
----------

radioco.apps.api.radiocom_views module
--------------------------------------

.. automodule:: radioco.apps.api.radiocom_views
:members:
:undoc-members:
:show-inheritance:

radioco.apps.api.recorder_views module
--------------------------------------

Expand Down
8 changes: 8 additions & 0 deletions docs/source/source_code/radioco.apps.api.tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ radioco.apps.api.tests.test_programmes module
:undoc-members:
:show-inheritance:

radioco.apps.api.tests.test_radiocom_api module
-----------------------------------------------

.. automodule:: radioco.apps.api.tests.test_radiocom_api
:members:
:undoc-members:
:show-inheritance:

radioco.apps.api.tests.test_recorder module
-------------------------------------------

Expand Down
22 changes: 22 additions & 0 deletions docs/source/source_code/radioco.apps.radioco.migrations.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
radioco.apps.radioco.migrations package
=======================================

Submodules
----------

radioco.apps.radioco.migrations.0001__v3_0__mysql_timezone module
-----------------------------------------------------------------

.. automodule:: radioco.apps.radioco.migrations.0001__v3_0__mysql_timezone
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: radioco.apps.radioco.migrations
:members:
:undoc-members:
:show-inheritance:
8 changes: 8 additions & 0 deletions docs/source/source_code/radioco.configs.base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ radioco.configs.base.settings module
:undoc-members:
:show-inheritance:

radioco.configs.base.test_runner module
---------------------------------------

.. automodule:: radioco.configs.base.test_runner
:members:
:undoc-members:
:show-inheritance:

radioco.configs.base.urls module
--------------------------------

Expand Down
22 changes: 22 additions & 0 deletions docs/source/source_code/radioco.configs.openshift.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
radioco.configs.openshift package
=================================

Submodules
----------

radioco.configs.openshift.settings module
-----------------------------------------

.. automodule:: radioco.configs.openshift.settings
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: radioco.configs.openshift
:members:
:undoc-members:
:show-inheritance:
38 changes: 38 additions & 0 deletions docs/source/source_code/radioco.configs.staging.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
radioco.configs.staging package
===============================

Submodules
----------

radioco.configs.staging.manage module
-------------------------------------

.. automodule:: radioco.configs.staging.manage
:members:
:undoc-members:
:show-inheritance:

radioco.configs.staging.settings module
---------------------------------------

.. automodule:: radioco.configs.staging.settings
:members:
:undoc-members:
:show-inheritance:

radioco.configs.staging.wsgi module
-----------------------------------

.. automodule:: radioco.configs.staging.wsgi
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: radioco.configs.staging
:members:
:undoc-members:
:show-inheritance:
40 changes: 40 additions & 0 deletions docs/source/upgrade/3.1.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#################
3.1 release notes
#################

*****************
What's new in 3.1
*****************

* Fixing staging docker port issue. (Thanks to `@mmontes11 <https://github.com/mmontes11>` for report)
* Adding stable `Radiocom API <https://github.com/ficiverson/radiocom-android>`_
* Solving ticket `#43 <https://github.com/iago1460/django-radio/issues/43>`_
* Upgrading libraries to last version
* Small fixes to invoke scripts
* Improving API (Outputting absolute urls and adding some fields)


********************
How this affects you
********************

If you’re starting with a new installation, you don’t need to worry about this.
Don’t even bother reading this section; it’s for upgraders.

You need to replace your current source with the content of https://github.com/iago1460/django-radio.
To setup your settings please read the configuration section.

You should be able to keep your current database but make sure to create a backup before start.

.. code-block:: bash
pip install -r radioco/configs/base/requirements.txt
python manage.py collectstatic
python manage.py migrate
Or if you are using our docker setup:

.. code-block:: bash
inv docker.clean -e staging
inv docker.setup -e staging
1 change: 1 addition & 0 deletions docs/source/upgrade/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ on any process that makes changes to your database.
2.1
3.0
3.0.1
3.1
2 changes: 1 addition & 1 deletion radioco/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.


__version__ = '3.0.1'
__version__ = '3.1'
2 changes: 1 addition & 1 deletion radioco/apps/radioco/tz_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ def recurrence_after(recurrence, after_dt, start_dt):
def recurrence_before(recurrence, before_dt, start_dt):
"""
Fix for django-recurrence 1.3
Avoid outputting a non impossible dt
Avoid outputting a impossible dt
"""
dt = recurrence.before(before_dt, True, dtstart=start_dt)
if dt == start_dt:
Expand Down

0 comments on commit 321cbbc

Please sign in to comment.