Theme Options
-
default_admonition_class
Defaut color of admonitions
type: str
default: is-light
-
breadcrumbs_at_top
Whether to shop breadcrumbs on the top of the page.
- type:
bool
- default:
False
-
canonical_url
Force all internal links to use this value as base url
type: str
default: None
-
collapse_navigation
type: bool
default: False
-
content_margin_left
type: str
default: None
example: 20px
-
content_padding_left
type: str
default: None
example: 20px
-
content_padding_top
If set to None the theme will determine the best default depending on whether the topbar is visible
type: str
default: None
example: 20px
-
display_version
type: bool
default: True
-
logo_only
Define a logo_path and set this to
True if you want to omit your project title and only show the
logo.
type: bool
default: False
-
logo_path
Relative path to your project’s source/_static
type: str
default: None
example: my-project-name.png
-
navigation_depth
The maximum depth of the toctree
type: int
default: 6
-
show_topbar
Whether to show topbar or sidebar
type: bool
default: False
Sets the color of project title on sidebar
type: str
default: has-text-dark
example: my-project-name.png
Sets the width of the sidebar
type: str
default: is-3
Whether to show sidebar on the right side of the page
type: bool
default: False
Defines the inline CSS rules for the sidebar. The theme will determine
the best margin for the sidebar by default but you can customize it
here.
type: str
default: None
example: margin: 32px
-
topbar_class
type: str
default: is-light
-
topbar_logo_class
type: str
default: image is-32x32