Skip to content

Invalid documentation syntax when sphinx-design is upgraded #404

Closed

Description

@AlexanderWells-diamond

In sphinx-design==0.8.0 they have deprecated the syntax we use on the card header/footer. See description here:

https://sphinx-design.readthedocs.io/en/latest/cards.html#legacy-separator-syntax

The issue this is causing is that all tests run by the Copier template which instantiate a new instance of the template end up pulling in the most recent versions of all Python packages. This means we have test failures that are quite hard to debug as they only appear in the newly instantiated templates, which I believe are deleted when the test ends.

The simple fix for now would be to update the sphinx-design package in main, and fix the deprecation warnings.

It is probably worth thinking about whether we want to take steps to avoid this issue in future - as it means that currently any CI run against even main will fail due to a third party updating their packages.

Activity

  1. added a commit that references this issue on Nov 13, 2026
  2. AlexanderWells-diamond commented on Nov 13, 2026

    @AlexanderWells-diamond
    ContributorAuthor

    Fixed in #405

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions