Skip to content

Conversation

@th3linja
Copy link

Reference issue

Fixes #9112

What does this implement/fix?

Creating a page that steps through the various IDE settings that are helpful when contributing to MNE-Python.

Additional information

Picking up and resolving an idle ticket. Tried implementing some of the changes as suggested. Not sure if :menuselection: by Sphinx is working as rst is not displaying correctly for me when installing MNE right out of the box. May require additional setup to view it correctly.

@welcome
Copy link

welcome bot commented Mar 30, 2023

Hello! 👋 Thanks for opening your first pull request here! ❤️ We will try to get back to you soon. 🚴

@larsoner
Copy link
Member

Looks like a useful start! Two issues so far:

D:\a\1\s\doc\install\contributing.rst:4: WARNING: duplicate label contributing, other instance in D:\a\1\s\doc\install\configure_ide.rst
...
checking consistency... D:\a\1\s\doc\install\configure_ide.rst: WARNING: document isn't included in any toctree

@drammock or @britta-wstnr could comment more on where this would fit given the current structure and the discussion in #11609

@th3linja th3linja closed this Mar 31, 2023
@britta-wstnr
Copy link
Member

Not sure why this is closed now, but it indeed looks like a good addition to the contributor guide! I have not started on refactoring of that guide yet - so I have no good idea where to put it right now. Let me get back on that next week!

@larsoner larsoner mentioned this pull request Mar 31, 2023
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 this pull request may close these issues.

ENH: IDE configuration docs

3 participants