betty.project.extension.cotton_candy package¶
Submodules¶
- betty.project.extension.cotton_candy.config module
ColorConfiguration
CottonCandyConfiguration
CottonCandyConfiguration.DEFAULT_LINK_ACTIVE_COLOR
CottonCandyConfiguration.DEFAULT_LINK_INACTIVE_COLOR
CottonCandyConfiguration.DEFAULT_PRIMARY_ACTIVE_COLOR
CottonCandyConfiguration.DEFAULT_PRIMARY_INACTIVE_COLOR
CottonCandyConfiguration.__init__()
CottonCandyConfiguration.dump()
CottonCandyConfiguration.featured_entities
CottonCandyConfiguration.link_active_color
CottonCandyConfiguration.link_inactive_color
CottonCandyConfiguration.load()
CottonCandyConfiguration.primary_active_color
CottonCandyConfiguration.primary_inactive_color
CottonCandyConfiguration.update()
- betty.project.extension.cotton_candy.search module
Module contents¶
Provide Betty’s default theme.
- final class betty.project.extension.cotton_candy.CottonCandy[source]¶
Bases:
ShorthandPluginBase
,Theme
,CssProvider
,ConfigurableExtension
[CottonCandyConfiguration
],Jinja2Provider
,WebpackEntryPointProvider
Provide Betty’s default front-end theme.
- __init__(project: Project, public_css_paths: Sequence[str])[source]¶
This is internal. It MAY be used anywhere in Betty’s source code, but MUST NOT be used by third-party code.
- classmethod assets_directory_path() Path [source]¶
Return the path on disk where the extension’s assets are located.
This may be anywhere in your Python package.
- classmethod comes_after() set[PluginIdentifier[Extension]] [source]¶
The extensions that this one comes after.
The other extensions may or may not be enabled.
- classmethod default_configuration() CottonCandyConfiguration [source]¶
Get this extension’s default configuration.
- classmethod depends_on() set[PluginIdentifier[Extension]] [source]¶
The extensions this one depends on, and comes after.
- property filters: Mapping[str, Callable[[...], Any]]¶
Jinja2 filters provided by this extension.
Keys are filter names, and values are the filters themselves.
- async classmethod new_for_project(project: Project) Self [source]¶
Create a new instance using the given project.
- property public_css_paths: Sequence[str]¶
The public URL paths to the CSS files to include in each HTML page.
- register_event_handlers(registry: EventHandlerRegistry) None [source]¶
Register event handlers with the project.
- betty.project.extension.cotton_candy.associated_file_references(has_file_references: HasFileReferences) Iterable[FileReference] [source]¶
Get the associated file references for an entity that has file references.