Skip to content

DOC: Add mne-videobrowser to related software #13544

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

Open
ttaiv wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: Add mne-videobrowser to related software #13544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions doc/sphinxext/related_software.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@

# If it's available on PyPI, add it to this set:
PYPI_PACKAGES = {
"mne-videobrowser",
Copy link
Member

@larsoner larsoner Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The preferred way actually is to add it here

https://github.com/mne-tools/mne-installers/blob/9b11999de2874071170f99a4915218a38b055328/recipes/mne-python/construct.yaml#L75-L141

We should add a note to this file, though, that this is the preferred method. That is, 1) get your package on PyPI and conda-forge, 2) add it to mne-installers recipe, and 3) update doc/sphinxext/related_software.py

If you need help adding to conda-forge let me know, but it's pretty painless nowadays using grayskull

Copy link
Author

@ttaiv ttaiv Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I'll try to add it that way. But did I already update doc/sphinxext/related_software.py correctly? The file has comment # If a package is in MNE-Installers, it will be automatically added!, so I am wondering should I touch that file at all if I do steps 1) and 2). And how about the file doc/sphinxext/related_software.txt?

Copy link
Member

@larsoner larsoner Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should update # If a package is in MNE-Installers, it will be automatically added! to say that it still needs to be added to doc/sphinxext/related_software.txt as CircleCI needs the software actually installed to pull the necessary info from it. So once your package is on conda-forge your PR here can 1) update that comment and 2) update related_software.txt

"cross-domain-saliency-maps",
"meggie",
"niseq",
Expand Down
1 change: 1 addition & 0 deletions doc/sphinxext/related_software.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ mne-lsl
mne-microstates
mne-nirs
mne-rsa
mne-videobrowser
mnelab
neurodsp
neurokit2
Expand Down