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

[DOC] License link in documentation 404's #102

Closed
adswa opened this issue Aug 18, 2022 · 1 comment · Fixed by #106
Closed

[DOC] License link in documentation 404's #102

adswa opened this issue Aug 18, 2022 · 1 comment · Fixed by #106

Comments

@adswa
Copy link

adswa commented Aug 18, 2022

Hello 👋 :)
I read through the documentation and notived that the "License" header in the documentation points to https://raw.githubusercontent.com/mne-tools/mne-icalabel/blob/main/LICENSE, which does not resolve. The correct link would be https://raw.githubusercontent.com/mne-tools/mne-icalabel/main/LICENSE.

Here's a patch:

diff --git a/doc/index.rst b/doc/index.rst
index 2a33c25..257ed39 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -32,7 +32,7 @@ Contents
    :hidden:
    :caption: Development
 
-   License <https://raw.githubusercontent.com/mne-tools/mne-icalabel/blob/main/LICENSE>
+   License <https://raw.githubusercontent.com/mne-tools/mne-icalabel/main/LICENSE>
    Contributing <https://github.com/mne-tools/mne-icalabel/blob/main/CONTRIBUTING.md>
 
 License

Found while doing openjournals/joss-reviews#4484

PS: I noticed that your repositories "About" overview section on the right links to the development version instead of the stable version of the documentation - is this intentional? Not in any way a problem, adding here as an FYI in case its an unintentional pre-first-release residual, because the empty "Whats new" page in the development version caught my eye and I'm used to redirection to the stable docs by mne-python. Ignore if this choice intentional or preferred.

@mscheltienne
Copy link
Member

Thanks for the review, that should be fixed, I'll check when it's deployed. For the link in the "About" overview section, @adam2392 do you have any preference?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants