[MRG] Adding docs for release (#37)

* Adding docs for release * Try again * Fix * Fix
mne-tools · Sep 8, 2021 · 4773db0 · 4773db0
1 parent 454ff47
commit 4773db0
Show file tree

Hide file tree

Showing 7 changed files with 97 additions and 30 deletions.
diff --git a/doc/_templates/navbar.html b/doc/_templates/navbar.html
@@ -9,6 +9,7 @@
   <ul class="dropdown-menu" aria-labelledby="dropdownMenu1">
     <li><a href="https://mne.tools/mne-connectivity/dev/index.html">Development</a></li>
     <li><a href="https://mne.tools/mne-connectivity/stable/index.html">Stable</a></li>
+    <li><a href="https://mne.tools/mne-connecitivity/v0.2/index.html">v0.1</a></li>
     <li><a href="https://mne.tools/mne-connecitivity/v0.1/index.html">v0.1</a></li>
   </ul>
 </div>

diff --git a/doc/_templates/version-switcher.html b/doc/_templates/version-switcher.html
@@ -0,0 +1,11 @@
+<div class="dropdown">
+    <button type="button" class="btn btn-{% if (build_dev_html|tobool) %}danger{% else %}primary{% endif %} btn-sm navbar-btn dropdown-toggle" id="dLabelMore" data-toggle="dropdown">
+        v{{ release }}
+        <span class="caret"></span>
+    </button>
+    <div class="dropdown-menu list-group-flush py-0" aria-labelledby="dLabelMore">
+        {%- for ver, txt in versions_dropdown.items() %}
+        <a class="list-group-item list-group-item-action py-1" href="https://mne.tools/mne-bids/{{ ver }}/index.html">{{ txt }}</a>
+        {%- endfor %}
+    </div>
+</div>
diff --git a/doc/authors.inc b/doc/authors.inc
@@ -1 +1,3 @@
-.. _Adam Li: https://github.com/adam2392
+.. _Adam Li: https://github.com/adam2392
+.. _Eric Larson: https://github.com/larsoner
+.. _Britta Westner: https://github.com/britta-wstnr
diff --git a/doc/conf.py b/doc/conf.py
@@ -122,6 +122,7 @@
     'use_edit_page_button': False,
     'navigation_with_keys': False,
     'show_toc_level': 1,
+    'navbar_end': ['version-switcher', 'navbar-icon-links'],
 }
 # Custom sidebar templates, maps document names to template names.
 html_sidebars = {
@@ -130,7 +131,8 @@
 
 html_context = {
     'versions_dropdown': {
-        'dev': 'v0.2 (devel)',
+        'dev': 'v0.3 (devel)',
+        'v0.2': 'v0.2',
         'v0.1': 'v0.1',
     },
 }

diff --git a/doc/whats_new.rst b/doc/whats_new.rst
@@ -16,46 +16,31 @@ Here we list a changelog of MNE-connectivity.
 
 .. _current:
 
-Current
--------
+Version 0.3 (Unreleased)
+------------------------
 
-In this version, we return the relevant Connectivity class from each of the
-connectivity estimation functions. These internally use ``xarray`` to represent
-the connectivity data. One can easily get the v0.1 numpy array by doing
-``conn.get_data()``, which will get exactly the same output as one got in v0.1
-running any of the connectivity functions.
+...
 
-Changelog
-~~~~~~~~~
+Enhancements
+~~~~~~~~~~~~
 
-- Adding `Connectivity`, `TemporalConnectivity`, `SpectralConnectivity` and `SpectroTemporalConnectivity` as a data structure to hold connectivity data, by `Adam Li`_ (:gh:`6`)
-- Adding `EpochConnectivity`, `EpochTemporalConnectivity`, `EpochSpectralConnectivity` and `EpochSpectroTemporalConnectivity` as a data structure to hold connectivity data over Epochs, by `Adam Li`_ (:gh:`6`)
-- ``indices`` argument in Connectivity classes can now be ``symmetric``, allowing for memory-efficient storage of symmetric connectivity, by `Adam Li`_ (:gh:`20`)
-- New function ``save`` in Connectivity classes along with :func:`read_connectivity` can now be used to write and read Connectivity data as netCDF files, by `Adam Li`_ (:gh:`20`)
-- New function :func:`vector_auto_regression` to compute dynamic connectivity vector auto-regressive (VAR) model, by `Adam Li`_ (:gh:`23`)
+- ...
 
 Bug
 ~~~
 
+- ...
+
 API
 ~~~
 
-- :func:`envelope_correlation`, :func:`spectral_connectivity`, and :func:`phase_slope_index` all return ``_Connectivity`` containers now, by `Adam Li`_ (:gh:`6`)
-- Added ``xarray`` as a dependency where all connectivity containers are now underlying xarrays, by `Adam Li`_ (:gh:`6`)
-- The ``combine`` argument in :func:`envelope_correlation` was removed, and now all Epoch Connectivity classes have a ``combine`` class function, by `Adam Li`_ (:gh:`20`)
-
-
-Changes when mne-connectivity was part of MNE-Python
-----------------------------------------------------
-
-In July, 2021, ``mne.connectivity`` submodule was ported over from the MNE-Python 
-repo into this repository, ``mne-connectivity``. Starting v0.24 of MNE-Python, that sub-module 
-will be deprecated and development will move over into this repository. Starting v0.25 of MNE-Python,
-``mne.connectivity`` will completely be removed.
+- ...
 
 Authors
 ~~~~~~~
 
-* Adam Li
+* `Adam Li`_
+
+:doc:`Find out what was new in previous releases <whats_new_previous_releases>`
 
 .. include:: authors.inc
diff --git a/doc/whats_new_previous_releases.rst b/doc/whats_new_previous_releases.rst
@@ -0,0 +1,66 @@
+:orphan:
+
+.. _whats_new_in_previous_releases:
+
+.. currentmodule:: mne_connectivity
+
+What was new in previous releases?
+==================================
+
+.. _changes_0_2:
+
+Version 0.2 (2021-09-07)
+------------------------
+
+In this version, we return the relevant Connectivity class from each of the
+connectivity estimation functions. These internally use ``xarray`` to represent
+the connectivity data. One can easily get the v0.1 numpy array by doing
+``conn.get_data()``, which will get exactly the same output as one got in v0.1
+running any of the connectivity functions.
+
+Changelog
+~~~~~~~~~
+
+- Adding `Connectivity`, `TemporalConnectivity`, `SpectralConnectivity` and `SpectroTemporalConnectivity` as a data structure to hold connectivity data, by `Adam Li`_ (:gh:`6`)
+- Adding `EpochConnectivity`, `EpochTemporalConnectivity`, `EpochSpectralConnectivity` and `EpochSpectroTemporalConnectivity` as a data structure to hold connectivity data over Epochs, by `Adam Li`_ (:gh:`6`)
+- ``indices`` argument in Connectivity classes can now be ``symmetric``, allowing for memory-efficient storage of symmetric connectivity, by `Adam Li`_ (:gh:`20`)
+- New function ``save`` in Connectivity classes along with :func:`read_connectivity` can now be used to write and read Connectivity data as netCDF files, by `Adam Li`_ (:gh:`20`)
+- New function :func:`vector_auto_regression` to compute dynamic connectivity vector auto-regressive (VAR) model, by `Adam Li`_ (:gh:`23`)
+
+API
+~~~
+
+- :func:`envelope_correlation`, :func:`spectral_connectivity`, and :func:`phase_slope_index` all return ``_Connectivity`` containers now, by `Adam Li`_ (:gh:`6`)
+- Added ``xarray`` as a dependency where all connectivity containers are now underlying xarrays, by `Adam Li`_ (:gh:`6`)
+- The ``combine`` argument in :func:`envelope_correlation` was removed, and now all Epoch Connectivity classes have a ``combine`` class function, by `Adam Li`_ (:gh:`20`)
+
+Authors
+~~~~~~~
+
+People who contributed to this release (in alphabetical order):
+
+* `Adam Li`_
+* `Eric Larson`_
+* `Britta Westner`_
+
+.. _changes_0_1:
+
+Version 0.1 (2021-06-25)
+------------------------
+
+Changes when mne-connectivity was part of MNE-Python
+----------------------------------------------------
+
+In July, 2021, ``mne.connectivity`` submodule was ported over from the MNE-Python 
+repo into this repository, ``mne-connectivity`` as v0.1. Starting v0.24 of MNE-Python, that sub-module 
+will be deprecated and development will move over into this repository. Starting v0.25 of MNE-Python,
+``mne.connectivity`` will completely be removed.
+
+Authors
+~~~~~~~
+
+People who contributed to this release (in alphabetical order):
+
+* `Adam Li`_
+
+.. include:: authors.inc
diff --git a/mne_connectivity/__init__.py b/mne_connectivity/__init__.py
@@ -6,7 +6,7 @@
 #
 # License: BSD (3-clause)
 
-__version__ = '0.2.dev0'
+__version__ = '0.2'
 
 from .base import (Connectivity, EpochConnectivity, EpochSpectralConnectivity,
                    EpochSpectroTemporalConnectivity, EpochTemporalConnectivity,