ThemeModel

pydantic model documenteer.conf._toml.ThemeModel

Model for theme configurations in documenteer.toml.

Parameters:

data (Any)

Show JSON schema

{
   "title": "ThemeModel",
   "description": "Model for theme configurations in documenteer.toml.",
   "type": "object",
   "properties": {
      "show_github_edit_link": {
         "default": true,
         "description": "Show a link to edit on GitHub if True",
         "title": "Show Github Edit Link",
         "type": "boolean"
      },
      "header_links_before_dropdown": {
         "default": 5,
         "description": "Number of links in the header nav before showing a 'More' dropdown.",
         "title": "Header Links Before Dropdown",
         "type": "integer"
      },
      "show_last_updated": {
         "default": true,
         "description": "Show a 'Last updated' timestamp at the bottom of each page derived from Git commit dates if True",
         "title": "Show Last Updated",
         "type": "boolean"
      }
   }
}

Fields:

• header_links_before_dropdown (int)

• show_github_edit_link (bool)

• show_last_updated (bool)

field header_links_before_dropdown: int = 5

Number of links in the header nav before showing a ‘More’ dropdown.

field show_github_edit_link: bool = True

Show a link to edit on GitHub if True

field show_last_updated: bool = True

Show a ‘Last updated’ timestamp at the bottom of each page derived from Git commit dates if True