Skip to content

Doc folder reorg #12043

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

Merged
merged 18 commits into from
Oct 3, 2023
Merged

Doc folder reorg #12043

merged 18 commits into from
Oct 3, 2023

Conversation

drammock
Copy link
Member

@drammock drammock commented Oct 1, 2023

closes #11691

remaining TODOs / questions:

  • manual_install_python is crufty?
  • design_philosophy is crufty / should be split?
  • cookbook should be split (separate PR)
  • faq needs overhaul (separate PR)
  • matlab.rst cruft?

@larsoner
Copy link
Member

larsoner commented Oct 1, 2023

manual_install_python is crufty?

Yes please make it as small as possible. I don't think we should be in the business of giving people details about how to get a working python, other than supporting our own installers. We could include one link to/mention generic Anaconda as well, and also say there are other, less common ways to get one (brew on macOS, python3-venv on Ubuntu, etc.), but we should make it clear that 1) MNE should work with all of them but also 2) we don't explicitly support setting those up. That would give people enough stuff to Google if they want to go a different route from just using our installers.

design_philosophy is crufty / should be split?

The content at least seems okay. Some of it is coding conventions but "design philosophy" seems like an okay catchall to use. No idea how you could split it better at least

matlab.rst cruft?

Really we should move this one RST file to mne-matlab and deploy it to mne.tools/mne-matlab. It shouldn't live in our repo. Feel free to do it now, or I can work on it tonight or tomorrow, and you can remove it here.

@larsoner
Copy link
Member

larsoner commented Oct 1, 2023

... also I linked this somewhere but you could consider addressing this, too if you're already planning to mess with content more than git mv

#10707

@drammock
Copy link
Member Author

drammock commented Oct 2, 2023

pending happy CIs this one is ready for review/merge.

Copy link
Member

@larsoner larsoner left a comment

Choose a reason for hiding this comment

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

We'll need some redirects in conf.py. At the very least all of the API pages should redirect, maybe some of the others if they're deemed sufficiently necessary

@drammock
Copy link
Member Author

drammock commented Oct 2, 2023

We'll need some redirects in conf.py.

done in 2f0f8f8

maybe some of the others if they're deemed sufficiently necessary

done in f1ad928:

  • contributing guide
  • roadmap
  • what's new

@larsoner larsoner enabled auto-merge (squash) October 2, 2023 19:10
@larsoner
Copy link
Member

larsoner commented Oct 2, 2023

Marking for merge when green, thanks in advance @drammock !

@hoechenberger
Copy link
Member

I don't think we should be in the business of giving people details about how to get a working python, other than supporting our own installers.

I totally agree and that's something that has always bothered me.

@larsoner larsoner merged commit c6863e5 into mne-tools:main Oct 3, 2023
@drammock drammock deleted the doc-folder-reorg branch October 3, 2023 10:53
@drammock drammock mentioned this pull request Oct 10, 2023
snwnde pushed a commit to snwnde/mne-python that referenced this pull request Mar 20, 2024
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.

RFC: doc/ folder reorg
3 participants