sphinx-doc/sphinx

Table of contents and footer can overlap when using `stickysidebar`

Open

#11,557 opened on Aug 7, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (1,985 forks)batch import
help wantedhtml theme

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 merged PRs in 30d)

Description

Describe the bug

The problem occurs when the content of a page is "shorter" than the table of contents.

Here is a real example (that occurs in combination with fulltoc):

image

And this is my minimal example (without fulltoc):

image

How to Reproduce

conf.py

project = 'test'
copyright = '2023, me'
author = 'me'
release = '0.0'

extensions = []

templates_path = ['_templates']
exclude_patterns = []

html_theme = 'classic'
html_static_path = ['_static']
html_theme_options = {"stickysidebar": True}

index.rst

page 1
======

.. toctree::
   :hidden:

   page2

page2

page 2
======

Environment Information

Platform:              win32; (Windows-10-10.0.19045-SP0)
Python version:        3.11.2 (tags/v3.11.2:878ead1, Feb  7 2023, 16:38:35) [MSC v.1934 64 bit (AMD64)])
Python implementation: CPython
Sphinx version:        7.1.2
Docutils version:      0.20.1
Jinja2 version:        3.1.2
Pygments version:      2.14.0

Sphinx extensions

No response

Additional context

No response

Contributor guide

Research direction
Inspect the CSS for the sticky sidebar and footer in the classic theme. Use developer tools to identify the overlap and adjust positioning to prevent the footer from being covered.
Tech stack
python
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonCSS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75