Skip to content

get_started.md

Latest commit

 

History

History
139 lines (96 loc) · 3.82 KB

get_started.md

File metadata and controls

139 lines (96 loc) · 3.82 KB

Getting Started

:avatar: images/ebp-logo.png
:avatar-link: https://executablebooks.org
:author: "[Chris Sewell](https://github.com/chrisjsewell)"
:date: "{sub-ref}`today`"
:read-time: "1 min read"
:class-avatar: sd-animate-grow50-rot20

Usage

Simply pip install sphinx-design and add the extension to your conf.py:

extensions = ["sphinx_design"]

For using with MyST Parser, for Markdown documentation, it is recommended to use the colon_fence syntax extension:

extensions = ["myst_parser", "sphinx_design"]
myst_enable_extensions = ["colon_fence"]

Configuration

To hide the title header of a page, add to the top of the page:

::::{tab-set} :::{tab-item} MyST Markdown

---
sd_hide_title: true
---

::: :::{tab-item} RestructuredText

:sd_hide_title:

::: ::::

Creating custom directives

:::{versionadded} 0.6.0 :::

You can use the sd_custom_directives configuration option in your conf.py to add custom directives, with default option values:

sd_custom_directives = {
    "dropdown-syntax": {
        "inherit": "dropdown",
        "argument": "Syntax",
        "options": {
            "color": "primary",
            "icon": "code",
        },
    }
}

The key is the new directive name to add, and the value is a dictionary with the following keys:

  • inherit: The directive to inherit from (e.g. dropdown)
  • argument: The default argument (optional, only for directives that take a single argument)
  • options: A dictionary of default options for the directive (optional)

Supported browsers

  • Chrome >= 60
  • Firefox >= 60
  • Firefox ESR
  • iOS >= 12
  • Safari >= 12
  • Explorer >= 12

(Mirrors: https://github.com/twbs/bootstrap/blob/v5.0.2/.browserslistrc)

Migrating from sphinx-panels

This package arose as an iteration on sphinx-panels, with the intention to make it more flexible, easier to use, and minimise CSS clashes wth sphinx themes.

Notable changes:

Reduce direct use of CSS classes

These are replaced by the use of directive options, which are:

  • Easier to understand
  • Easier to validate
  • Easier to work with non-HTML outputs
  • Easier to improve/refactor

panel directive replaced

The panel directive is replaced by the use of the top-level grid directive, then using grid-item-card directive children, rather than delimiting cards by ---.

If no card is needed, then the grid-item directive can be used instead and card can be also used independently of grids.

Approximately, .. panels:: is equivalent to .. grid:: 1 2 2 2 with option :gutter: 2.

tabbed directive replaced

The tabbed directive is replaced by the use of the top-level tab-set directive, then using tab-item directive children.

The :sync: option allows to synchronize tab selection across sets.

The tab-set-code directive provides a shorthand for synced code examples.

link-button directive replaced

The link-button directive is replaced by the use of button-ref/button-link.

Directive options have also been added to replace the use of classes:

  • stretched-link -> :click-parent:
  • btn-block -> :expand:

octicon icon role

The default SVGs produced are now sized relative to the surrounding text (i.e. using 1em). The syntax for specifying a custom size and adding classes is also changed.

This is similar for favicon icons, where the , delimiter is also replaced by ;, e.g. :fa:`name,class` -> :fa:`name;class` .

Improved CSS

Updated Bootstrap CSS from v4 -> v5, which in particular allows top-level grid to define both column numbers and gutter sizes.

All CSS classes are prefixed with sd- (no clash with other theme/extension CSS)

All colors use CSS variables (customisable)