Make heading-style use the font-weight-heading value #1213

vkbo · 2023-02-23T10:32:21Z

The heading-style class is ignoring the --pst-font-weight-heading setting. This fixes that, but I'm wondering if the change was intentional at some point. The --pst-font-weight-heading seems to be used for admonitions and various boxes, and is set by default to 600. This fix will now make all main content headings also 600.

Maybe there should be a separate variable for this? It may make sense to differentiate.

Edit: It seems the variable was added in #818, and only used for those places where font-weight was 600. Since the default font-weight for content headers is 400, maybe there should be a "base" version of the variable for those cases?

Closes #1212

choldgraf · 2023-02-23T12:54:29Z

I'm a fan of making the heading weights bold (at least for h1 and h2)...

...but if we don't quickly get consensus on that, then I suggest defining a new variable that we use for admonition font weights and then lowering our header font weight variable value to 400 so that nothing visually changes and we just use a more sensible variable name.

12rambau

I don't have a strong opinion on that but I think making sure it's taken into account will surelly make @trallard work easier

trallard · 2023-02-23T13:16:01Z

Thanks for the ping - as part of the style changes proposed elsewhere I had considered swapping the weight to 600 so if everyone else is happy with this I am +1 too.

Though it might be best having this as a separate variable anyway and allow folks to customise the weight. I can see some people preferring either a bolder or thinner weight.

choldgraf · 2023-02-23T13:19:18Z

Yeah I think it's worth decoupling "article headers" from "admonition headers" style either way.

vkbo · 2023-02-23T13:22:08Z

The current variable is used for admonitions and the prev/next titles.

Current settings:

// Sidebar styles
--pst-sidebar-font-size: 0.9rem;
--pst-sidebar-font-size-mobile: 1.1rem;
--pst-sidebar-header-font-size: 1.2rem;
--pst-sidebar-header-font-weight: 600;

// Font weights
--pst-font-weight-caption: 300;
--pst-font-weight-heading: 600;

To be consistent with the sidebar section, I could add

--pst-admonition-header-font-weight: 600;

and replace it where --pst-font-weight-heading is used, and set that to 400?

choldgraf

One quick thought but it LGTM !

choldgraf · 2023-02-24T13:14:25Z

src/pydata_sphinx_theme/assets/styles/variables/_fonts.scss

  // Font weights
  --pst-font-weight-caption: 300;
-  --pst-font-weight-heading: 600;
+  --pst-font-weight-heading: 400;


Could you be consistent in the naming structure? So either "heading-font-weight" or "font-weight-heading". Here they are mixed...

Sure, I just chose to be consistent with --pst-sidebar-header-font-weight instead.

Ah if this is a more general inconsistency in our docs, then don't worry about it

It's an inconsistency in the code. Do you want me to revert the change?

* Fix extra whitespace in sidebars (pydata#1115) * Fix extra whitespace in sidebars * Searchbox * Update src/pydata_sphinx_theme/__init__.py Co-authored-by: Daniel McCloy <dan@mccloy.info> * make test pass * Fix template filter to remove empty files * ABlog in template test * Move clear search button to primary sidebar * Move search clear button to top of article Co-authored-by: Daniel McCloy <dan@mccloy.info> * FIX: Use logo_url instead deprecated logo in theme (pydata#1094) (pydata#1097) resolves pydata#1094 * ENH/MAINT: avoid overwriting the HtmlTranslator (pydata#1105) Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> Fix pydata#143 Fix pydata#94 * fix: align sidebar sliding with the buttons (pydata#1123) * fix: aline the sidebar sliding with the buttons * build: force test to run on all platform if one platform is failing we cannot see if it's platform related as the other were closed * fix: use correct path for documentation logo * MAINT: Improve font sizing (pydata#1129) Fix pydata#1001 * MAINT: Refactor workflows to reduce test dependencies (pydata#1136) * MAINT: update prerelease workflow (pydata#1140) * ABlog: Updates for new HTML structure (pydata#1118) * ABlog: Updates for new HTML structure * Update templates for latest release * Bump to dev0 * Standardize logo image behavior between Sphinx and this theme (pydata#1132) Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> * 0.13.0rc1 * Build(deps): Bump http-cache-semantics from 4.1.0 to 4.1.1 (pydata#1154) * DOC: Use only shield.io for badges in README (pydata#1152) * Copyright semicolon (pydata#1160) * FIX: Flex behavior should shrink header items instead of brand (pydata#1158) Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> Fixes pydata#1143 * STYLE: lint the documentation with Doc8 (pydata#1150) Fix pydata#1139 * Add test for internationalization and translations (pydata#1138) * FIX: Javascript incorrect check for variable (pydata#1166) * MAINT: update pypi classifiers (pydata#1153) Fix pydata#1106 * remove emoji from landing page (pydata#1151) * add fa icons instead of emoji * remove fix for emojis * use markup for readme emojis * use pst-color-primary instead of sd-text-primary * make our semantic colors available as classes * try again --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * FIX: Narrow scope of style rule for GitHub & GitLab link shortening (pydata#1167) Fixes pydata#1156 * ENH: Add breadcrumbs to article header (pydata#1142) * ENH: Add breadcrumbs to article header * Update src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/breadcrumbs.html Co-authored-by: Tania Allard <taniar.allard@gmail.com> * More fixes * Improving nested page behavior * Documenting breadcrumbs * Update src/pydata_sphinx_theme/assets/styles/components/_breadcrumbs.scss Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * Breacrumbs have link color --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * Degrade gracefully when JavaScript is disabled (pydata#1146) * Fix header vertical spacing and jupyter-sphinx cells (pydata#1164) Fixes undefined * RLS: v0.13.0rc2 (pydata#1170) * DOCS: admonition customization (pydata#1155) * first draft of the admonition customization * typo in doc link * flesh out admon. customization example; DRY * use :code:rst instead of :literal: * Update docs/_static/custom.css --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Fix article header CSS (pydata#1171) * “Edit this page” → “Edit on GitHub/GitLab/Bitbucket” (pydata#1177) * “Edit this page” → “Edit on GitHub/GitLab/Bitbucket” Fixes pydata#1172 * Add tests * Fix typo * Properly handle default_mode=auto when writing logos (pydata#1183) We used to only defaulting to the light version when `default_mode` was undefined, not when it was explicitly set to `auto`. We also need to handle the latter, as the new test shows. Closes pydata#1180 Co-authored-by: Jérémy Bobbio (Lunar) <lunar@softwareheritage.org> * fix: correctly add DOM listeners (pydata#1179) fix adding DOM listeners * maint: update GitLab URL tests (pydata#1186) Co-authored-by: JoerivanEngelen <joerivanengelen@hotmail.com> * Standardize template structure in more sections (pydata#1184) * Standardize template structure in all sections * Fixing footer behavior * Update docs/user_guide/layout.rst Co-authored-by: Daniel McCloy <dan@mccloy.info> * Remove use of id= as much as possible --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * maint: remove sphinx-panels support; remove deprecated config shims (pydata#1188) * Minor style improvements to ablog (pydata#1185) * RLS: v0.13.0rc3 * dev0 * FIX: Some style bugs (pydata#1191) * FIX: Some style bugs * Move link word wrap to global rule * DOCS: Add internationalization instructions (pydata#1178) Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> * Refactor contributing docs to be more modular (pydata#1173) * Dev0 * Fix github gitlab brand (pydata#1194) * RLS: v0.13.0rc4 * FIX: Make wide equations scroll (pydata#1196) * Fix math scrollbars for realz (pydata#1198) * Fix math scrollbars for realz * Update src/pydata_sphinx_theme/assets/styles/content/_math.scss * Update src/pydata_sphinx_theme/assets/styles/content/_math.scss * copy_logo_images: do not render dynamic Sphinx template content (pydata#1204) * copy_logo_images: do not render dynamic Sphinx template content when copying logo image files * Update src/pydata_sphinx_theme/__init__.py --------- Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> * Add conditional check for last-updated template (pydata#1201) * Add conditional check for last-updated template * Whitespace * Properly set configuration with app.builder.theme_options (pydata#1199) * Properly set configuration * Dict to values * Making it explicit in a function * Better name * Fix test * Foot * Revert complex config set * Clarify docs * Use CSS transform for skip link (pydata#1206) * feat: Add full i18n support (pydata#1192) Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> * Dev0 * FIX: Remove icon links component when no icon links given (pydata#1209) * RLS: 0.13.0rc5 * dev0 * FIX: Get theme options in a more robust way (pydata#1214) * RLS: v0.13.0rc6 * Make heading-style use the font-weight-heading value (pydata#1213) * Make heading-style use the font-weight-heading value * Separate font-weight setting for content headers and admonitions * Flip var to be consistent with --pst-font-weight-heading instead * RLS: v0.13.0 * bump: dev0 * DOCS: Remove <p> from announcement sample text (pydata#1223) --------- Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Nico Albers <nico.albers@aboutyou.com> Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Brendan Heberlein <bheberlein@wisc.edu> Co-authored-by: Tania Allard <taniar.allard@gmail.com> Co-authored-by: Lunar <lunar@debian.org> Co-authored-by: Jean Abou-Samra <jean@abou-samra.fr> Co-authored-by: Jérémy Bobbio (Lunar) <lunar@softwareheritage.org> Co-authored-by: JoerivanEngelen <joerivanengelen@hotmail.com> Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> Co-authored-by: James Addison <55152140+jayaddison@users.noreply.github.com> Co-authored-by: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com>

Make heading-style use the font-weight-heading value

c86ead5

12rambau reviewed Feb 23, 2023

View reviewed changes

Separate font-weight setting for content headers and admonitions

2a53450

12rambau approved these changes Feb 24, 2023

View reviewed changes

choldgraf reviewed Feb 24, 2023

View reviewed changes

Flip var to be consistent with --pst-font-weight-heading instead

87a4de7

drammock approved these changes Feb 24, 2023

View reviewed changes

drammock merged commit 157c9ab into pydata:main Feb 24, 2023

vkbo deleted the head_font_weight branch February 24, 2023 22:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make heading-style use the font-weight-heading value #1213

Make heading-style use the font-weight-heading value #1213

vkbo commented Feb 23, 2023 •

edited

Loading

choldgraf commented Feb 23, 2023

12rambau left a comment

trallard commented Feb 23, 2023

choldgraf commented Feb 23, 2023

vkbo commented Feb 23, 2023

choldgraf left a comment

choldgraf Feb 24, 2023

vkbo Feb 24, 2023

choldgraf Feb 24, 2023

vkbo Feb 24, 2023

Make heading-style use the font-weight-heading value #1213

Make heading-style use the font-weight-heading value #1213

Conversation

vkbo commented Feb 23, 2023 • edited Loading

choldgraf commented Feb 23, 2023

12rambau left a comment

Choose a reason for hiding this comment

trallard commented Feb 23, 2023

choldgraf commented Feb 23, 2023

vkbo commented Feb 23, 2023

choldgraf left a comment

Choose a reason for hiding this comment

choldgraf Feb 24, 2023

Choose a reason for hiding this comment

vkbo Feb 24, 2023

Choose a reason for hiding this comment

choldgraf Feb 24, 2023

Choose a reason for hiding this comment

vkbo Feb 24, 2023

Choose a reason for hiding this comment

vkbo commented Feb 23, 2023 •

edited

Loading