README Base Builder¶
osa_tool.operations.docs.readme_generation.generator.base_builder
¶
MarkdownBuilderBase
¶
citation
cached
property
¶
Generates the README Citation section
documentation
property
¶
Generates the README Documentation section
examples
property
¶
Generates the README Examples section
getting_started
property
¶
Generates the README Getting Started section
license
property
¶
Generates the README License section
overview
property
¶
Generates the README Overview section
load_template()
¶
Loads a TOML template file and returns its sections as a dictionary.
table_of_contents(sections)
staticmethod
¶
Generates an adaptive Table of Contents based on provided sections.