xyzstyle

xyzstyle - A Sphinx theme for documentation.

This module provides a custom Sphinx theme for creating beautiful documentation.

Functions

get_html_theme_path(→ str)	Return the path to the HTML theme directory.
setup(→ sphinx.util.typing.ExtensionMetadata)	Set up the xyzstyle Sphinx theme.

Package Contents

xyzstyle.get_html_theme_path() → str

Return the path to the HTML theme directory.

返回:

Absolute path to the theme directory.

返回类型:

str

xyzstyle.setup(app: sphinx.application.Sphinx) → sphinx.util.typing.ExtensionMetadata

Set up the xyzstyle Sphinx theme.

This function is called by Sphinx when the extension is loaded.

参数:

app -- Sphinx application instance.

返回:

Dictionary of metadata for the extension.

返回类型:

ExtensionMetadata