#200
gdtest_site_combo
OK
CONFIG
Site setting combo: cosmo theme + toc-depth:3 + toc-title:'Contents' + display_name.
Combination: cosmo theme + toc-depth:3 + custom toc-title + display_name. All site settings together.
Build Mode
● Has great-docs.yml
This package ships a pre-supplied config.
The great-docs init step is skipped and
great-docs build uses the spec-defined configuration directly.
Tests specific config options and their rendered output.
Dimensions
Q1 Q5 Q6 K12
Q1Cosmo themetheme
Q5TOC depth 3theme
Q6Custom TOC titletheme
K12display_name overrideconfig
Source Files
gdtest_site_combo/
__init__.py
"""Package testing site setting combo with display_name."""
__all__ = ["setup", "render", "publish"]
def setup(config: dict) -> None:
"""Set up the site with the given configuration.
Parameters
----------
config : dict
A dictionary of site configuration options.
Returns
-------
None
Examples
--------
>>> setup({"theme": "cosmo"})
"""
pass
def render(template: str) -> str:
"""Render a template into HTML.
Parameters
----------
template : str
The template string to render.
Returns
-------
str
The rendered HTML output.
Examples
--------
>>> render("<h1>Title</h1>")
'<h1>Title</h1>'
"""
return template
def publish(site: str) -> bool:
"""Publish the site to the given destination.
Parameters
----------
site : str
The site name or URL to publish to.
Returns
-------
bool
True if publishing was successful.
Examples
--------
>>> publish("my-site")
True
"""
return TrueREADME.md
# gdtest-site-combo Test site setting combo with display_name.
great-docs.yml
display_name: Combo Site site: theme: cosmo toc-depth: 3 toc-title: Contents