Sphinx Design Components#

Cards and tabs provide some extra UI flexibility for your content. Both sphinx-design and sphinx-panels can be used with this theme. This theme provides custom CSS to ensure that their look and feel is consistent with this theme.

See also

For more about how to use these extensions, see the sphinx-design documentation.

Danger

sphinx-panels is no longer maintained and we recommend you switch to sphinx-design. We will deprecate support for sphinx-panels soon.

To use the sphinx-panels extention, add these lines to your custom CSS to overwrite the shadows of the panels:

/* overwrite panels shadows using pydata-sphinx-theme variable */
.shadow {
    box-shadow: 0 0.5rem 1rem var(--bst-color-shadow) !important;
}

This modification is not needed when using the sphinx-design extention.

Below you can find some examples of the components created with the sphinx-design extension.

Badges and buttons#

Here are some of the available badges: primary secondary success primary outline secondary outline success outline

Here are some buttons, also using semantic color names. Note: in this theme, info is defined to be the same color as primary, and warning is the same color as secondary. If in your site’s custom CSS file you override the CSS custom properties --bst-color-* (where * is one of the semantic color names, e.g., primary, danger, etc), badges and buttons will automatically use the custom color.

Cards#

Only heading

Only body.

But with multiple text paragraphs.

Heading and body

Content of the third card.

example

A card with a dropdown menu

A clickable card

panel 1 header

panel 1 content more content

panel 1 footer

panel 2 header

panel 2 content

panel 2 footer

Tabs#

c++

int main(const int argc, const char **argv) {
    return 0;
}

python

def main():
    return

java

class Main {
    public static void main(String[] args) {
    }
}

julia

function main()
end

fortran

PROGRAM main
END PROGRAM main

Dropdowns#

Dropdowns should look similar to admonitions, but clickable. See the Sphinx Design Dropdown documentation for more information.

An admonition for reference.

And some admonition content.

Copybuttons#

sphinx-copybutton adds a copy button to each of your code cells. You can see it in action by hovering over the code cell below:

print("A copybutton in the top-right!")

Toggle buttons#

sphinx-togglebutton allows you to convert admonitions into toggle-able elements.

Click me to toggle!

This will be hidden until a click!

A standalone toggle button!

Last updated on Jan 16, 2024.

Theme-specific elements

Using bulma extensions