Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to Read the Docs v2 #260

Merged
merged 2 commits into from Aug 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 16 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,16 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the doc/ directory with Sphinx
sphinx:
configuration: doc/conf.py

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: doc/requirements.txt
7 changes: 3 additions & 4 deletions doc/installing.rst
Expand Up @@ -25,7 +25,7 @@ If you use a zsh shell, you need to write `pip install -e .\[docs,tests\]`. If y
Dependencies
~~~~~~~~~~~~

- Python (>= 3.7)
- Python >= 3.8

Mandatory dependencies
^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -34,14 +34,13 @@ Mandatory dependencies

- `scipy <http://www.scipy.org/>`__

- `scikit-learn >=0.22 <http://scikit-learn.org/>`__
- `scikit-learn >=0.24 <http://scikit-learn.org/>`__

- `joblib <https://joblib.readthedocs.io/>`__


Recommended dependencies
^^^^^^^^^^^^^^^^^^^^^^^^
These dependencies are recommanded to use the plotting functions of pyriemann or to run examples and tutorials, but they are not mandatory:
These dependencies are recommanded to use the plotting functions of pyRiemann or to run examples and tutorials, but they are not mandatory:

- `mne-python <http://mne-tools.github.io/>`__

Expand Down
4 changes: 3 additions & 1 deletion doc/whatsnew.rst
Expand Up @@ -10,14 +10,16 @@ A catalog of new features, improvements, and bug-fixes in each release.
v0.6.dev
--------

- Update pyRiemann from Python 3.7 to 3.8. pr`254` by :user:`qbarthelemy`
- Update pyRiemann from Python 3.7 to 3.8. :pr:`254` by :user:`qbarthelemy`

- Speedup pairwise distance function :func:`pyriemann.utils.distance.pairwise_distance`
by adding individual functions for 'euclid', 'harmonic', 'logeuclid' and 'riemann' metrics. :pr:`256` by :user:`gabelstein`

- Add :func:`pyriemann.utils.test.is_real_type` to check the type of input arrays and
add :func:`pyriemann.utils.covariance.covariance_scm` allowing to process complex-valued inputs for 'scm' covariance estimator. :pr:`251` by :user:`qbarthelemy`

- Update to Read the Docs v2. :pr:`260` by :user:`qbarthelemy`


v0.5 (Jun 2023)
---------------
Expand Down