Configuration

class Config(BaseConfig):
  """The plugin's configuration."""

  theme = c.Optional(c.Theme(default=None))
  """Override the theme used by your MkDocs instance."""

  formats = c.SubConfig(FormatsConfig)
  """The formats to generate."""

  buttons = c.ListOfItems(c.SubConfig(ButtonConfig), default=[])
  """The buttons to add."""

  logging = c.SubConfig(LoggingConfig)
  """The logging configuration."""

class ButtonConfig(BaseConfig):
  """The configuration of a button."""

  enabled = c.Type((bool, Callable), default=True)
  """Is the button enabled?"""

  title = c.Type((str, Callable))
  """The button's title."""

  icon = c.Type((str, Callable))
  """The button's icon (typically, an SVG element)."""

  attributes = c.Type((dict, Callable), default={})
  """Some extra attributes to add to the button."""

class FormatsConfig(BaseConfig):

  pdf = c.SubConfig(PDFFormatConfig)
  """The PDF format configuration."""

class LoggingConfig(BaseConfig):
  """The logging configuration."""

  level = c.Choice(['debug', 'info', 'warning', 'error', 'critical'], default='info')
  """The log level."""