scriptutils.generate_markdown

Module Contents

Functions

generate_distribution_summary(root: str, doc: sbol3.Document)

Generate a Markdown README file summarizing distribution contents, suitable for automatic display on GitHub

generate_package_summary(package: str, doc: sbol3.Document)

Generate a Markdown README file summarizing package contents that is suitable for automatic display on GitHub

hilite(text: str)

Emphasize a piece of markdown text with bold and red formatting

Attributes

DISTRIBUTION_SUMMARY

File name for the distribution summary, to be located in the root directory

SUMMARY_FILE

File name for markdown summaries
DISTRIBUTION_SUMMARY = README_distribution.md

File name for the distribution summary, to be located in the root directory

SUMMARY_FILE = README.md

File name for markdown summaries

generate_distribution_summary(root: str, doc: sbol3.Document)

Generate a Markdown README file summarizing distribution contents, suitable for automatic display on GitHub

Parameters

  • root – path for summary to be written to

  • doc – package document to summarize

Returns

None

generate_package_summary(package: str, doc: sbol3.Document)

Generate a Markdown README file summarizing package contents that is suitable for automatic display on GitHub

Parameters

  • package – package being summarized

  • doc – package document to summarize

Returns

None

hilite(text: str)

Emphasize a piece of markdown text with bold and red formatting