Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion doc/sphinxext/related_software.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
1. Add it to the MNE-installers if possible, and it will automatically appear.
2. If it's on PyPI and not in the MNE-installers, add it to the PYPI_PACKAGES set.
3. If it's not on PyPI, add it to the MANUAL_PACKAGES dictionary.

If PyPI or manual, also add package name to `related_software.txt` or
`related_software_nodeps.txt` so that it's installed at doc-build time (for package
metadata querying).
"""

# Authors: The MNE-Python contributors.
Expand Down Expand Up @@ -35,6 +39,7 @@
"niseq",
"sesameeg",
"mne-kit-gui", # moved to its own env in the installers
"zuna",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Any thoughts on adding to conda-forge and mne-installers instead? I can give it a quick try if you want @jonasmago

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Yeah, I thought about it at first and wasn't sure which of those two places would be the best one to place it. I do think they do make sense.
Shall I add it there from my end?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah if you can get a conda forge package going (I use grayskull) that's preferable

}

# If it's not available on PyPI, add it to this dict:
Expand Down Expand Up @@ -221,7 +226,7 @@ def run(self):
return [my_list]


def setup(app):
def setup(app): # noqa: D103
app.add_directive("related-software", RelatedSoftwareDirective)
# Run it as soon as this is added as a Sphinx extension so that any errors
# / new packages are reported early. The next call in run() will be cached.
Expand Down
1 change: 1 addition & 0 deletions doc/sphinxext/related_software_nodeps.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ fsleyes
mne-kit-gui
mne-videobrowser
hedtools # because it limits our Pandas version currently
zuna # requires pytorch
Loading