dask / dask/dask-sphinx-theme

Offset page content

Open
#57 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
6
Forks
15
PR merge metrics
No merged PRs in 30d

Description

After migrating to the new `sphinx-book-theme` (xref https://github.com/dask/dask-sphinx-theme/pull/54), I noticed when navigating to a specific subsection of a page, the section title is covered up. For example, previously https://docs.dask.org/en/stable/array-creation.html#concatenation-and-stacking would look like:

Screen Shot 2021-10-07 at 4 16 44 PM

while with the new theme we have:

Screen Shot 2021-10-07 at 4 15 54 PM

(Note the "Concatenation and Stacking" title is covered).

I recall this happening before, even with the old theme, because we didn't account for the width of the top navbar in the Dask theme. This was resolved by https://github.com/dask/dask-sphinx-theme/pull/27. Perhaps we didn't carry that extra CSS over when we switched themes?

cc @jacobtomlinson

Contributor guide

Open the contributing guide

Research direction

Reproduce the covered subsection heading at the linked array-creation.html anchor, then inspect the theme changes in dask-sphinx-theme PRs #54 and #27 for the navigation-offset CSS. Done means subsection headings remain visible below the top navbar when navigating to an anchor.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.