betty.extension.http_api_doc package¶
Module contents¶
Integrate Betty with ReDoc.
- class betty.extension.http_api_doc.HttpApiDoc[source]¶
Bases:
UserFacingExtension,WebpackEntryPointProviderProvide user-friendly HTTP API documentation.
- Parameters:
app (
betty.app.App)args (
typing.Any)kwargs (
typing.Any)
- classmethod assets_directory_path() pathlib.Path[source]¶
Return the path on disk where the extension’s assets are located.
This may be anywhere in your Python package.
- Return type:
- classmethod depends_on() set[type[betty.app.extension.Extension]][source]¶
The extensions this one depends on, and comes after.
- Return type:
- classmethod description() betty.locale.Str[source]¶
Get the human-readable extension description.
- Return type:
- classmethod label() betty.locale.Str[source]¶
Get the human-readable extension label.
- Return type:
- webpack_entry_point_cache_keys() collections.abc.Sequence[str][source]¶
Get the keys that make a Webpack build for this provider unique.
Providers that can be cached regardless may
return ().- Return type:
- classmethod webpack_entry_point_directory_path() pathlib.Path[source]¶
Get the path to the directory with the entry point assets.
The directory must include at least a
package.jsonandmain.ts.- Return type: