Skip to content

On deviations from the PyData Sphinx Theme and Sphinx-Design styles #681

@agriyakhetarpal

Description

@agriyakhetarpal

In #679 (comment), I raised the issue that the PST stylesheets include CSS rules for dark mode (xref #618) that apply to images and logos. @stefanv suggests that we should remove such rules. I'd like to discuss the following points here:

  • Such a deviation from the PST stylesheets needs to be documented somewhere, as newer versions of the PST may reapply them when we update our styles to them.
    • How do we do this? Do we document the changes in a README file and add instructions for updating the stylesheets, so that care is taken to ensure that the deviations are valid? this also applies a visual bug on inconsistency in the PST (one we file, for example) is fixed in a newer version, not just with the introduction of bugs or inconsistencies.
  • If we do deviate from the theme, how much is acceptable (considering there is/was a big effort to do this in Unify w/ pydata sphinx theme #225/Importing styles from pydata-sphinx-theme #302)?

Happy to hear your thoughts!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions