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: Reflow IDE doc #12947

Merged
merged 2 commits into from
Nov 5, 2024
Merged

DOC: Reflow IDE doc #12947

merged 2 commits into from
Nov 5, 2024

Conversation

larsoner
Copy link
Member

@larsoner larsoner commented Nov 5, 2024

Closes #12944

@SophieHerbst @hoechenberger can you see if this is better? Changes:

  1. Split the IDE section into its own ides.rst file and added it to the hidden toctree so now "IDE integration (VSCode, Spyder, etc.)" is an entry in the left sidebar

    main PR
    image image
  2. Added a card that pops up when you click "download" that links to that section:

    before click after click
    image image

@@ -0,0 +1,55 @@
.. _ide_setup:

IDE integration (VSCode, Spyder, etc.)
Copy link
Member Author

@larsoner larsoner Nov 5, 2024

Choose a reason for hiding this comment

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

This file is 100% cut-paste other than updating this title from Python IDE integration to IDE integration (VSCode, Spyder, etc.) to be more discoverable (removed Python to make it more compact given the new discoverable term additions)

:class-body: text-center
:class-card: install-download-alert hidden

.. We have to use a button-link here because button-ref doesn't properly nested parse the inline code
Copy link
Member Author

Choose a reason for hiding this comment

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

doc/install/installers.rst Outdated Show resolved Hide resolved
@hoechenberger
Copy link
Member

I love the card!!!

couldn't really look at the rest yet

Co-authored-by: Daniel McCloy <dan@mccloy.info>
@larsoner larsoner added this to the 1.9 milestone Nov 5, 2024
@drammock drammock enabled auto-merge (squash) November 5, 2024 19:34
@drammock drammock merged commit 2983d2a into mne-tools:main Nov 5, 2024
28 checks passed
@drammock drammock deleted the scraper branch November 5, 2024 20:17
@SophieHerbst
Copy link
Contributor

Looks great, thank you!

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

Successfully merging this pull request may close these issues.

Installation instructions: add IDE setup to installer page
4 participants