Skip to content

module authored_file

Library object with author.

Global Variables

  • TYPE_CHECKING

class AuthoredFile

Authored data file.

method __init__

__init__(
    author: Optional[ForwardRef('AuthorFile')] = None,
    **kwargs: Any
) → None

Parse content if provided.

property content

File content.

Automatically generate content from object's fields if not assigned.

Return file link.

property file_name

Markdown file name.

Automatically generate file name from book's fields if not assigned.

property path

Return file path.

method rename_author

rename_author(new_author: str) → None

Rename author.

We do not re-render the file fully to keep intact possible user changes in it.

This file was automatically generated via lazydocs.