Reference¶

This section documents the supported public API.

Public API¶

httk.web.api.create_asgi_app(srcdir: str | Path, *, baseurl: str | None = None, compatibility_mode: bool = False, config_name: str = 'config', debug: bool = False) → Starlette[source]¶

httk.web.api.serve(srcdir: str | Path, *, host: str = '127.0.0.1', port: int = 8080, baseurl: str | None = None, compatibility_mode: bool = False, config_name: str = 'config', debug: bool = False) → None[source]¶

httk.web.api.publish(srcdir: str | Path, outdir: str | Path, baseurl: str, *, compatibility_mode: bool = False, config_name: str = 'config', use_urls_without_ext: bool | None = None) → PublishReport[source]¶

Convenience Exports¶

httk.web.create_asgi_app(srcdir: str | Path, *, baseurl: str | None = None, compatibility_mode: bool = False, config_name: str = 'config', debug: bool = False) → Starlette[source]¶

httk.web.serve(srcdir: str | Path, *, host: str = '127.0.0.1', port: int = 8080, baseurl: str | None = None, compatibility_mode: bool = False, config_name: str = 'config', debug: bool = False) → None[source]¶

httk.web.publish(srcdir: str | Path, outdir: str | Path, baseurl: str, *, compatibility_mode: bool = False, config_name: str = 'config', use_urls_without_ext: bool | None = None) → PublishReport[source]¶