qpydoc API document (0.1.2)

generate_site

Generate Quarto website project

generate_site(
    pkg_name: str,
    locale: Optional[str]=None,
    sidebar_width: Optional[str]=None,
    prefix: Optional[str]=None,
    favicon: Optional[str]=None,
)

• pkg_name (str): package name
• prefix (Optional[str]): project directory name. default to f”{pkg_name}_api”
• locale (Optional[str]): locale. default to “en_US”
• sidebar_width (Optional[str]): sidebar width. default to “350px”
• favicon (Optional[str]): favicon path