betty.extension.http_api_doc package¶
Module contents¶
Integrate Betty with ReDoc.
- final class betty.extension.http_api_doc.HttpApiDoc[source]¶
Bases:
Extension
,WebpackEntryPointProvider
Provide user-friendly HTTP API documentation.
- Parameters:
project (
betty.project.Project
)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 plugin_description() betty.locale.localizable.Localizable [source]¶
Get the human-readable long plugin description.
- Return type:
- classmethod plugin_id() str [source]¶
Get the plugin ID.
IDs are unique per plugin type: - A plugin repository MUST at most have a single plugin for any ID. - Different plugin repositories MAY each have a plugin with the same ID.
- Return type:
- classmethod plugin_label() betty.locale.localizable.Localizable [source]¶
Get the human-readable short plugin 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.json
andmain.ts
.- Return type: