Skip to content

Commit

Permalink
Merge pull request #2580 from alejoe91/clarify-docs
Browse files Browse the repository at this point in the history
Clarify status of main and Sortinganalyzer
  • Loading branch information
samuelgarcia authored Mar 15, 2024
2 parents edbd52e + 1aedf95 commit ad7187a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,11 @@
[![Twitter](https://img.shields.io/badge/@spikeinterface-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/spikeinterface) [![Mastodon](https://img.shields.io/badge/-@spikeinterface-%232B90D9?style=for-the-badge&logo=mastodon&logoColor=white)](https://fosstodon.org/@spikeinterface)


> :warning::warning::warning: **PRs with new features are frozen!**: after the 0.100.0 release, we will not accept PRs with new features (only bug fixes) until February 21st 2024.
> :warning::warning::warning:
> **New features under construction!** 🚧🚧🚧: after the 0.100.0 release (and related bug fixes), the next release will contain
> a major API improvement: the `SortingAnalyzer`. To read more about this, checkout the
> [enhancement proposal](https://github.com/SpikeInterface/spikeinterface/issues/2282).
> Please refer to the stable documentation [here](https://spikeinterface.readthedocs.io/en/0.100.1)

SpikeInterface is a Python framework designed to unify preexisting spike sorting technologies into a single code base.
Expand All @@ -70,7 +74,7 @@ With SpikeInterface, users can:

## Documentation

Detailed documentation of the latest PyPI release of SpikeInterface can be found [here](https://spikeinterface.readthedocs.io/en/0.100.0).
Detailed documentation of the latest PyPI release of SpikeInterface can be found [here](https://spikeinterface.readthedocs.io/en/0.100.1).

Detailed documentation of the development version of SpikeInterface can be found [here](https://spikeinterface.readthedocs.io/en/latest).

Expand Down
8 changes: 8 additions & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ With a few lines of code, SpikeInterface enables you to load and pre-process the
state-of-the-art spike sorters, post-process and curate the output, compute quality metrics, and visualize the results.


.. warning::

**New features under construction!** 🚧🚧🚧: after the 0.100.0 release (and related bug fixes), the next release will contain
a major API improvement: the :code:`SortingAnalyzer`. To read more about this, checkout the
`enhancement proposal <https://github.com/SpikeInterface/spikeinterface/issues/2282>`_.
Please refer to the stable documentation `here <https://spikeinterface.readthedocs.io/en/0.100.1>`_


Overview of SpikeInterface modules
----------------------------------

Expand Down

0 comments on commit ad7187a

Please sign in to comment.