← Previous | Next →
  • »
  • Options

Options

The Alice theme supports a series of theme-specific options specified through the html_theme_options configuration. A full option set is as follows:

html_theme_options = {
    #'canonical_url': 'https://www.example.com',
    #'includehidden': False,
    #'navigation_depth': 4,
    #'prev_next_buttons_location': 'both',
    #'titles_only': False,
}

For standard HTML configuration and theme options, also consult:

The following outlines the specific theme options provided by this extension:

canonical_url

Specifies the value which should be added (if any) into the canonical link HTML element in every page header. By default, no canonical element is added.

html_theme_options = {
    'canonical_url': 'https://www.example.com',
}

includehidden

Specifies whether or not the navigation will includes hidden marked table(s) of contents. By default, table(s) of contents which are marked with the :hidden: option remain hidden with a value of False.

html_theme_options = {
    'includehidden': True,
}

prev_next_buttons_location

Configures how “Next” and “Previous” links (if any) should be rendered in the final documentation set. Permitted values include both, top, bottom or none. By default, these links are included in both the top and the bottom of each page.

html_theme_options = {
    'prev_next_buttons_location': 'both',
}

titles_only

Specifies whether or not only titles (not subheadings) of a document are included in table(s) of contents. By default, subheadings are permitted with a value of False.

html_theme_options = {
    'titles_only': True,
}