Visitar URL original
Dark mode: topic background colour not applied in Sphinx 6.2.0 · Issue #132 · python/python-docs-theme · GitHub
Skip to content

Dark mode: topic background colour not applied in Sphinx 6.2.0 #132

Description

@hugovk

Currently the 3.12 docs are built with Sphinx 4.5.0 (it's shown in the page footer) and 3.13 with Sphinx 6.2.0.

Compare these pages in dark mode:

Python 3.12 / Sphinx 4.5.0 Python 3.13 / Sphinx 6.2.0
image image

Looks fine in light mode:

Python 3.12 / Sphinx 4.5.0 Python 3.13 / Sphinx 6.2.0
image image

Previously, we had this CSS from pydoctheme_dark.css applied to <div class="contents local topic" id="contents">:

div.topic,
div.note {
    background-color: rgba(255, 255, 255, 0.1);
    border-color: currentColor;
}

But now the HTML structure has changed to <nav class="contents local" id="contents"> so the CSS doesn't apply.

The source RST:

.. contents::
   :depth: 1
   :local:

Activity

  1. changed the title [-]Dark mode: topic and note background colour not applying in Sphinx 6.2.0[/-] [+]Dark mode: topic background colour not applied in Sphinx 6.2.0[/+] on Jul 5, 2023
  2. hugovk commented on Jul 7, 2023

    @hugovk
    MemberAuthor

    Bisecting the Sphinx releases, this first occurred between Sphinx 5.0.1 and 5.0.2.

    Checking the diff:

    sphinx-doc/sphinx@v5.0.1...v5.0.2

    Which contains this commit: sphinx-doc/sphinx@5806f0a

    Add nav.contents everywhere that div.topic is used

    From this PR: sphinx-doc/sphinx#10535

    Which fixed this issue: sphinx-doc/sphinx#10534

    Which said:

    Previously, docutils produced div.topic for the contents directive, the latest version produces nav.contents.

    This means that those tables of contents change appearance when switching to docutils 0.18.

    So let's try the same fix as sphinx-doc/sphinx@5806f0a.

  3. hugovk commented on Jul 15, 2023

    @hugovk
    MemberAuthor
  4. hugovk commented on Jul 27, 2023

    @hugovk
    MemberAuthor

    Please see PR #138 to fix this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions