toc.follow not respected: right sidebar does not scroll or show "passed" items

[melissawm]

With a vanilla set up of this theme, the toc.follow feature seems to not be respected. The right sidebar does not scroll when the page has a large number of items, and there is no difference between items that have "passed", active items and items further down in the page.

I am probably doing something wrong, but can't detect what it is from the docs.

Here's how that looks:

And here's the source code: https://github.com/melissawm/minimalsphinx

Any help would be appreciated. Thanks!

[2bndy5]

It looks like you're using firefox in the picture. Is this behavior also observed in chrome?

[melissawm]

Yes, it's exactly the same on chrome. Also, I do see the effect in the deployed documentation for sphinx-immaterial, which is why I was expecting this to work at all.

[2bndy5]

Can you point me to the page in our docs? I haven't seen this behavior. I tried quickly reproducing this locally but was unsuccessful.

[melissawm]

Oh I mean in your docs it works correctly in my browser 😄 See, for example, here: https://sphinx-immaterial.readthedocs.io/en/latest/admonitions.html

I am happy to help debug and submit a PR. I know this is coming in some way from mkdocs-material and if you can point me to the entry point for this functionality I might be able to take a look. Inspecting the code, I see that your pages are rendered with each item in the sidebar with class md-nav__link md-nav__sticky - even when using toc.follow (or toc.sticky) I never get my elements to show md-nav__sticky so I assume something is going wrong there.

[2bndy5]

Does adding toc.sticky feature relieve the issue?

[melissawm]

Unfortunately no, same behavior.

[2bndy5]

Hmm, IIRC the current implementation for the toc.follow feature is inherited from upstream mkdocs-material implementation. There might be some modifications on our end.

[melissawm]

Oh wow, I found it. It's the palette: if it's not set, the scrollbar does not appear and the names are not highlighted accordingly. Would it be ok if I checked to see if having a default palette be applied (when it is unset) would solve the issue?

[jbms]

Yes that sounds good, thanks.

[2bndy5]

I looked for upstream issues that might be related.

• Sometimes toc.follow doesn't move last entries into view squidfunk/mkdocs-material#4960

It might be worth adding a default value for the palette in

sphinx-immaterial/sphinx_immaterial/__init__.py

Lines 29 to 41 in 3c8fe16

	DEFAULT_THEME_OPTIONS = {
	"features": [],
	"font": {"text": "Roboto", "code": "Roboto Mono"},
	"plugins": {
	"search": {},
	},
	"icon": {},
	"repo_url": "",
	"edit_uri": "",
	"globaltoc_collapse": True,
	"toc_title": None,
	"toc_title_is_page_title": False,
	}

The only disadvantage I can think of is our copying of the minified CSS specifically for the color palette. If no palette is specified, then the CSS is not copied to the build output. So adding a default value for the color palette would also suggest we don't conditionally copy the CSS and instead include it unconditionally.

sphinx-immaterial/sphinx_immaterial/css_and_javascript_bundles.py

Lines 136 to 146 in 3c8fe16

	theme_options = app.config["html_theme_options"]
	if theme_options and "palette" in theme_options:
	css_entries.append(
	Entry(
	code=(theme_bundles / "palette.css").read_text(encoding="utf-8"),
	sourcemap=(theme_bundles / "palette.css.map").read_text(
	encoding="utf-8"
	),
	priority=200,
	)
	)

[melissawm]

The other alternative would be to add a note to the documentation about this behavior.

[2bndy5]

The doc option would be easier. A PR is welcome.