use sphinx-design and theme's light/dark image selectors #10671

drammock · 2022-05-24T18:16:13Z

No description provided.

drammock · 2022-05-24T18:36:44Z

Circle failure reported upstream: mcmtroffaes/pybtex-docutils#21

larsoner · 2022-05-24T18:53:37Z

In the meantime, it's possible that adding is ignored and will be removed in Docutils to our ignores in conf.py might work around the issue

drammock · 2022-05-24T18:55:13Z

@mcmtroffaes is usually very quick, let's wait a day and see rather than hastily doing a version-pin or adding a warning-ignore

drammock · 2022-05-25T16:13:11Z

Another failure, reported upstream: numpy/numpydoc#399

seems like using sphinx 5.0 beta (which allows docutils 0.18) is behind these.

doc/sphinxext/sphinx_bootstrap_divs/__init__.py

drammock · 2022-06-01T15:23:04Z

dang, forgot to add sphinx_design to docs requirements. stand by.

larsoner · 2022-06-01T15:39:43Z

/home/circleci/project/doc/auto_tutorials/inverse/70_eeg_mri_coords.rst:125: ERROR: Unknown directive type "collapse".
/home/circleci/project/doc/overview/cite.rst:16: ERROR: Error in "dropdown" directive:
unknown option: "class".
/home/circleci/project/doc/overview/cite.rst:35: ERROR: Error in "dropdown" directive:
unknown option: "class".

hoechenberger · 2022-06-01T15:50:53Z

@drammock can you please ping me once it builds? I can then have a look and will review :) thanks!

drammock · 2022-06-01T15:55:20Z

argh, sorry, seems I ran my git grep from within doc/ instead of on the whole repo. I'll find/fix the others now.

larsoner · 2022-06-01T17:04:12Z

doc/sphinxext/sphinx_bootstrap_divs/__init__.py

-        _assemble(node, self)
-        return [node]
-
-


No suitable replacement for .. details:: in sphinx-design?

hmm, seems like it wasn't even being used:

$ git grep ".. details::" doc/sphinxext/sphinx_bootstrap_divs/__init__.py:70:# .. details:: doc/sphinxext/sphinx_bootstrap_divs/__init__.py:73: """Class for .. details:: directive."""

I think that means we can delete the entire sphinx-bootstrap-divs extension?

Yes, feel free!

hoechenberger · 2022-06-01T17:08:55Z

doc/install/manual_install.rst

+            $ mamba create --override-channels --channel=conda-forge --name=mne mne
+
+
+    .. tab-item:: macOS (M1 / Apple Silicon)


This entire bit is already gone in main and has been backported

dang, I must have messed up the rebase this morning. thanks for catching that. I just pushed a fix.

drammock · 2022-06-01T17:02:25Z

doc/install/check_installation.rst

-.. collapse:: |hand-paper| If you get an error...
-    :class: danger
+.. dropdown:: If you get an error...
+    :icon: alert-fill


here (and in other dropdowns) we can also later add things like :color: warning or :color: danger, but at present they don't work yet; see executablebooks/sphinx-design#70

drammock · 2022-06-01T17:04:09Z

doc/install/installers.rst

+        .. button-link:: https://github.com/mne-tools/mne-installers/releases/download/v1.0.3/MNE-Python-1.0.3_0-macOS_Intel.pkg
+            :ref-type: ref
+            :color: primary
+            :shadow:
+            :class: font-weight-bold
+
+            |cloud-download-alt| |ensp| Download for macOS
+
+        **Supported platforms:**
+        macOS 10.15 (Catalina) and newer (Intel and Apple Silicon)


this is where the changes in #10693 would end up I think

drammock · 2022-06-01T17:06:00Z

doc/install/installers.rst

+         let all_tab_nodes = document.querySelectorAll(
+             '.platform-selector-tabset')[0].children;
+         let input_nodes = [...all_tab_nodes].filter(
+             child => child.nodeName === "INPUT");
+         let tab_label_nodes = [...document.querySelectorAll('.sd-tab-label')];
+         let correct_label = tab_label_nodes.filter(
+             label => label.textContent.trim().toLowerCase() === platform)[0];
+         let hash = correct_label.getAttribute('for');
+         let correct_input = input_nodes.filter(node => node.id === hash)[0];
+         correct_input.checked = true;
+     });


there's probably a more elegant way to code this in JS, maybe @hoechenberger knows? Crossref for why it's so convoluted: executablebooks/sphinx-design#68

drammock · 2022-06-01T17:07:44Z

doc/sphinxext/sphinx_bootstrap_divs/__init__.py

-        _assemble(node, self)
-        return [node]
-
-


hmm, seems like it wasn't even being used:

$ git grep ".. details::" doc/sphinxext/sphinx_bootstrap_divs/__init__.py:70:# .. details:: doc/sphinxext/sphinx_bootstrap_divs/__init__.py:73: """Class for .. details:: directive."""

I think that means we can delete the entire sphinx-bootstrap-divs extension?

drammock · 2022-06-01T17:09:23Z

doc/install/index.rst

+            :shadow:
+            :class: font-weight-bold
+
+            |cloud-download-alt| |ensp| Download Installers


This (the cloud-download-alt) currently doesn't render correctly, probably should just get removed for now. Upstream issue: executablebooks/sphinx-design#66

Never mind my comments below, then! Feel free to comment out the icons for now then

larsoner · 2022-06-01T17:15:39Z

Something is wrong in https://output.circle-artifacts.com/output/job/31d5cf6e-0351-41c2-9738-bceed9164c77/artifacts/0/dev/install/index.html

larsoner · 2022-06-01T17:16:00Z

(fontawesome HTML is in the buttons)

drammock · 2022-06-01T17:16:08Z

Something is wrong in https://output.circle-artifacts.com/output/job/31d5cf6e-0351-41c2-9738-bceed9164c77/artifacts/0/dev/install/index.html

yep, I noted that in my review. Question is whether to wait for upstream fix, or live without the icons for now

larsoner

https://output.circle-artifacts.com/output/job/161d8c01-5078-412d-84c6-49439c3f42f9/artifacts/0/dev/install/installers.html#installers

@hoechenberger feel free to merge if you're happy!

hoechenberger · 2022-06-01T22:02:14Z

I will take a look tomorrow!

In any case we should probably not merge until we have native Apple Silicon installers ready, no?

I believe will get there until Friday.

larsoner · 2022-06-01T22:05:47Z

I think it's easiest to merge this, then deal with M1 whenever it's ready

hoechenberger · 2022-06-01T22:14:20Z

Ah sorry I was mistaken, I thought the phrasing in this PR already assumed we had native M1 builds. Seems my brain is a bit tired :) I'll review tomorrow morning CEST and merge, ok? :)

hoechenberger · 2022-06-02T10:02:08Z

I added a bit morge top-margin, otherwise all looks great to me! fantastic work!

hoechenberger · 2022-06-02T10:33:58Z

The Circle error is related to some setup problem. I successfully built with my changes locally. Going ahead and merging this one.

hoechenberger · 2022-06-02T10:34:08Z

Thanks @drammock!!

drammock mentioned this pull request Jun 1, 2022

Prepare installer download page for Apple Silicon #10693

Closed

drammock added 14 commits June 1, 2022 10:07

use theme's light/dark selectors for homepage logo

9b7ea81

update requirements w/ new theme commit hash [skip github][skip azp]

1556f54

convert install overview page to use sphinx-design

0f53348

use sphinx-design rST for platform selector (tabs)

20feaba

use sphinx-design buttons for install overview cards

05fc7dd

try sphinx-design dropdowns to replace collapse directive

a08b9e9

fix card header/footer missing border

f966bad

get JS working on installers page

33f3e8c

use tabs and dropdown on manual python install page (orphan)

96818b7

update manual-install page

b08b747

don't set color (affects text, not bg)

b684ede

convert another dropdown (contributing page)

0c9a007

another one

8427196

remove the custom class

f6664b7

drammock force-pushed the use-theme-dkmode branch from ca4c2b8 to f6664b7 Compare June 1, 2022 15:09

larsoner reviewed Jun 1, 2022

View reviewed changes

doc/sphinxext/sphinx_bootstrap_divs/__init__.py Outdated Show resolved Hide resolved

Update doc/sphinxext/sphinx_bootstrap_divs/__init__.py

09b7083

add sphinx_design to requirements_doc

51295b5

drammock requested a review from hoechenberger June 1, 2022 15:25

fix missed collapse directive; remove unnecessary classes

e08cea9

larsoner reviewed Jun 1, 2022

View reviewed changes

hoechenberger reviewed Jun 1, 2022

View reviewed changes

drammock commented Jun 1, 2022

View reviewed changes

fix bad rebase / remove obsolete tabset

216e4d4

drammock added 2 commits June 1, 2022 12:25

remove icons for now

ee95798

remove sphinx_bootstrap_divs

d202927

drammock changed the title ~~use theme's light/dark selectors for homepage logo~~ use sphinx-design and theme's light/dark image selectors Jun 1, 2022

larsoner approved these changes Jun 1, 2022

View reviewed changes

Add some more margin above buttons [skip azp][skip actions]

9fa53c4

hoechenberger approved these changes Jun 2, 2022

View reviewed changes

hoechenberger merged commit fc53916 into mne-tools:main Jun 2, 2022

drammock deleted the use-theme-dkmode branch June 3, 2022 18:25

drammock mentioned this pull request Jun 8, 2022

MAINT: Use better CSS for dark mode on website #10670

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

use sphinx-design and theme's light/dark image selectors #10671

use sphinx-design and theme's light/dark image selectors #10671

drammock commented May 24, 2022 •

edited by larsoner

drammock commented May 24, 2022

larsoner commented May 24, 2022

drammock commented May 24, 2022

drammock commented May 25, 2022

drammock commented Jun 1, 2022

larsoner commented Jun 1, 2022

hoechenberger commented Jun 1, 2022

drammock commented Jun 1, 2022

larsoner Jun 1, 2022

drammock Jun 1, 2022

larsoner Jun 1, 2022

hoechenberger Jun 1, 2022

drammock Jun 1, 2022

drammock Jun 1, 2022

drammock Jun 1, 2022

drammock Jun 1, 2022

drammock Jun 1, 2022

drammock Jun 1, 2022

larsoner Jun 1, 2022

larsoner commented Jun 1, 2022

larsoner commented Jun 1, 2022

drammock commented Jun 1, 2022 •

edited

larsoner left a comment

hoechenberger commented Jun 1, 2022

larsoner commented Jun 1, 2022

hoechenberger commented Jun 1, 2022

hoechenberger commented Jun 2, 2022

hoechenberger commented Jun 2, 2022

hoechenberger commented Jun 2, 2022

		$ mamba create --override-channels --channel=conda-forge --name=mne mne


		.. tab-item:: macOS (M1 / Apple Silicon)

use sphinx-design and theme's light/dark image selectors #10671

use sphinx-design and theme's light/dark image selectors #10671

Conversation

drammock commented May 24, 2022 • edited by larsoner

drammock commented May 24, 2022

larsoner commented May 24, 2022

drammock commented May 24, 2022

drammock commented May 25, 2022

drammock commented Jun 1, 2022

larsoner commented Jun 1, 2022

hoechenberger commented Jun 1, 2022

drammock commented Jun 1, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

larsoner commented Jun 1, 2022

larsoner commented Jun 1, 2022

drammock commented Jun 1, 2022 • edited

larsoner left a comment

Choose a reason for hiding this comment

hoechenberger commented Jun 1, 2022

larsoner commented Jun 1, 2022

hoechenberger commented Jun 1, 2022

hoechenberger commented Jun 2, 2022

hoechenberger commented Jun 2, 2022

hoechenberger commented Jun 2, 2022

drammock commented May 24, 2022 •

edited by larsoner

drammock commented Jun 1, 2022 •

edited