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.

Sign up for GitHub

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

Fix previous PR Docs #54

Merged
merged 5 commits into from
May 10, 2022
Merged

Fix previous PR Docs #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5a26c28
Fix installation instructions
adam2392 May 10, 2022
0b2483d
Point users to installer
adam2392 May 10, 2022
45043d2
Merge branch 'main' into docs
adam2392 May 10, 2022
4a8c7f2
Fix links
adam2392 May 10, 2022
e7e092e
Try again
adam2392 May 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,10 @@ To get the latest code using [git](https://git-scm.com/), open a terminal and ty

or one can install directly using pip

pip install --user -U https://api.github.com/repos/mne-tools/mne-icalabel/zipball/main
pip install https://api.github.com/repos/mne-tools/mne-icalabel/zipball/main

Alternatively, you can also download a
`zip file of the latest development version <https://github.com/mne-tools/mne-icalabel/archive/main.zip>`_.
[zip file of the latest development version](https://github.com/mne-tools/mne-icalabel/archive/main.zip).

# Contributing

Expand Down
5 changes: 3 additions & 2 deletions doc/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You may choose to install ``mne-icalabel`` `via conda <#Installation via conda>`
or Pip.

mne-icalabel works best with the latest stable release of MNE-Python. To ensure
MNE-Python is up-to-date, see their `installation instructions <https://mne.tools/stable/install/index.html>_`.
MNE-Python is up-to-date, see their `installation instructions <https://mne.tools/stable/install/index.html>`_.


Installation via Conda
Expand All @@ -41,6 +41,7 @@ simply run the following at the root of the repository:

.. code-block:: bash

# with python>=3.7 at least
python -m venv .venv
pip install mne-icalabel

Expand All @@ -60,4 +61,4 @@ error messages:
Installation via MNE-Installer
------------------------------
Since MNE v1.0, there is now a standalone MNE installer, which can also optionally install
MNE-ICALabel! See `MNE page <https://mne.tools/stable/install/installers.html>_` for more information.
MNE-ICALabel! See `MNE page <https://mne.tools/stable/install/installers.html>`_ for more information.