betty.extension.nginx package

Submodules

Module contents

Integrate Betty with nginx.

class betty.extension.nginx.Nginx[source]

Bases: ConfigurableExtension[NginxConfiguration], UserFacingExtension, Generator, ServerProvider, GuiBuilder, CommandProvider

Integrate Betty with nginx (and Docker).

Parameters:
classmethod assets_directory_path() pathlib.Path | None[source]

Return the path on disk where the extension’s assets are located.

This may be anywhere in your Python package.

Return type:

pathlib.Path | None

property commands: dict[str, Command]

The commands to provide.

classmethod default_configuration() betty.extension.nginx.config.NginxConfiguration[source]

Get this extension’s default configuration.

Return type:

betty.extension.nginx.config.NginxConfiguration

classmethod description() betty.locale.Str[source]

Get the human-readable extension description.

Return type:

betty.locale.Str

async generate(job_context: betty.generate.GenerationContext) None[source]

Generate (part of) a project’s site.

Parameters:

job_context (betty.generate.GenerationContext)

Return type:

None

gui_build() betty.extension.nginx.gui._NginxGuiWidget[source]

Build this extension’s Graphical User Interface component.

Return type:

betty.extension.nginx.gui._NginxGuiWidget

property https: bool

Whether the nginx server should use HTTPS.

classmethod label() betty.locale.Str[source]

Get the human-readable extension label.

Return type:

betty.locale.Str

property servers: Sequence[Server]

Provide one or more web servers.

property www_directory_path: str

The nginx server’s public web root directory path.