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

MRG, DOC: Bump theme version #9036

Merged
merged 9 commits into from
Mar 14, 2021
Merged

Conversation

drammock
Copy link
Member

@drammock drammock commented Mar 13, 2021

a few recent changes to pydata-sphinx-theme allow us to simplify things on our end:

  • they've implemented a comprehensive system-native font stack. Consequently I have un-vendored our webfonts to speed up page load times. Our site now continues to use Source Sans Pro and Source Code Pro if they're present on the user's system, and will fall back to a system-appropriate default otherwise.
  • they've improved how navbar icon links (top right corner) are handled. This greatly simplifies our template override doc/_templates/docs-navbar.html

Other changes:

  • CSS variables defined by the theme now all start with --pst-
  • adds icon link to our Discord server
  • small CSS fix so our in-text sidebar notes get done properly
  • update the font versions that Circle uses

@hoechenberger
Copy link
Member

hoechenberger commented Mar 13, 2021

The "sidebar fix" from ff23d41 could use a little margin at the bottom:

Screen Shot 2021-03-13 at 21 22 18

The padding is also different between top and bottom.

Also wondering if offering to make this box collapsible could be a good idea?

@hoechenberger
Copy link
Member

How about:

.sidebar {
  background-color: rgba(var(--pst-color-info)), 0.1);
  border: 1px solid rgb(var(--pst-color-info)));
  border-radius: 4px;
  padding: 1em 1em 0 1em;
  margin-bottom: 2rem;
  width: 90%;
}

?

@drammock
Copy link
Member Author

hmm, circle build is not matching what I saw locally @hoechenberger. I'm not surprised you had complaints about it :) I'll see what went wrong.

@drammock
Copy link
Member Author

OK well, I am stumped. the .. sidebar:: directive on the sphinx site itself is rendered as a div tag with class sidebar. The same happens locally for me. But on our Circle server, it gets rendered as an aside tag. A solid hour of comparing package versions, searching docs, and grepping source trees has me no closer to figuring out why this difference exists or what is causing it. So I'm just going to apply the CSS style to both div.sidebar and aside.sidebar and be done with it.

@drammock
Copy link
Member Author

OK, it's working now @hoechenberger:

Screenshot_2021-03-13_17-21-28

@drammock
Copy link
Member Author

turns out that div -> aside was a change in the HTML5 writer of docutils v0.17.

@drammock drammock changed the title DOC: Bump theme version MRG, DOC: Bump theme version Mar 14, 2021
@drammock
Copy link
Member Author

CI failures are LGTM's "cannot build merge commit" snafu, and a failure of test_make_screenshot[pyvista] on macOS py3.8

Ready for review/merge

@agramfort agramfort merged commit d309e3d into mne-tools:main Mar 14, 2021
@agramfort
Copy link
Member

thx @drammock

larsoner added a commit to vpeterson/mne-python that referenced this pull request Mar 15, 2021
* upstream/main: (135 commits)
  DOC: use bibtex in plot_source_power_spectrum_opm.py (mne-tools#8906) (mne-tools#9050)
  DOC: use bibtex in plot_sleep (mne-tools#9044)
  FIX: fix sideways helmet plot (mne-tools#9059)
  FIX: bibtex mne-tools#8933 (mne-tools#9047)
  Fix bibtex citation issue mne-tools#8929. (mne-tools#9051)
  bibtex fix plot_time_frequency_global_field_power (mne-tools#9052)
  Fixed bibtex references in plot_background_statistics (mne-tools#9046)
  Bibtex raw py (mne-tools#9048)
  DOC update footcite maxwell.py (mne-tools#9043)
  update footcite [skip github] [skip azp] (mne-tools#9054)
  Adding bibtex in plot_otp (mne-tools#9049)
  fix bibtex plot_evoked_whitening (mne-tools#9042)
  MAINT: Link earlier [skip github] [skip azp] (mne-tools#9041)
  DOC: convert references in plot_parcellation to use footcite (mne-tools#9032)
  MAINT: Fix circle (mne-tools#9039)
  ENH: Allow adding custom JavaScript to Report (mne-tools#9037)
  MRG, DOC: Bump theme version (mne-tools#9036)
  MAINT: Simplify expression (followup to mne-tools#9015) (mne-tools#9035)
  MRG, MAINT: Cleaner split, fewer skips in _brain tests (mne-tools#9029)
  MRG, ENH: viz.plot_drop_log() gains special-handling for subject=None (mne-tools#9015)
  ...
@drammock drammock deleted the bump-theme-version branch March 29, 2021 18:30
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.

3 participants