httk.serve.web.model.config¶

Define immutable configuration for a web site source tree.

Classes¶

SiteConfig

Describe the directories and URL policy used by a site engine.

Module Contents¶

class httk.serve.web.model.config.SiteConfig[source]¶

Describe the directories and URL policy used by a site engine.

Parameters:

srcdir – Absolute or relative site source directory.
content_subdir – Content directory name relative to srcdir.
static_subdir – Static directory name relative to srcdir.
template_subdir – Template directory name relative to srcdir.
functions_subdir – Function directory name relative to srcdir.
widgets_subdir – Widget directory name relative to srcdir.
baseurl – Optional site base URL.
host_static – Optional host URL for static assets.
compatibility_mode – Whether to use legacy site conventions.
config_name – Configuration module name.
publish_use_urls_without_ext – Whether published page links omit extensions.

srcdir: pathlib.Path[source]¶

content_subdir: str = 'content'[source]¶

static_subdir: str = 'static'[source]¶

template_subdir: str = 'templates'[source]¶

functions_subdir: str = 'functions'[source]¶

widgets_subdir: str = 'widgets'[source]¶

baseurl: str | None = None[source]¶

host_static: str | None = None[source]¶

compatibility_mode: bool = False[source]¶

config_name: str = 'config'[source]¶

publish_use_urls_without_ext: bool = True[source]¶

classmethod from_srcdir(srcdir, *, baseurl=None, host_static=None, compatibility_mode=False, config_name='config', publish_use_urls_without_ext=True)[source]¶

Build site configuration from a source directory.

Parameters:

srcdir (str | pathlib.Path) – Site source directory.
baseurl (str | None) – Optional site base URL.
host_static (str | None) – Optional host URL for static assets.
compatibility_mode (bool) – Whether to use legacy site conventions.
config_name (str) – Configuration module name.
publish_use_urls_without_ext (bool) – Whether published page links omit extensions.

Returns: