project_config.reporters.ghf_markdown module

Github flavored Markdown reporters.

class project_config.reporters.ghf_markdown.GithubFlavoredMarkdownColorReporter(rootdir: str, fmt: Optional[str] = None, only_hints: bool = False)[source]

Bases: GithubFlavoredMarkdownReporter

_abc_impl = <_abc._abc_data object>

class project_config.reporters.ghf_markdown.GithubFlavoredMarkdownReporter(rootdir: str, fmt: Optional[str] = None, only_hints: bool = False)[source]

Bases: BaseNoopFormattedReporter

Github flavored Markdown reporter.

_abc_impl = <_abc._abc_data object>

generate_data_report(data_key: str, data: dict[str, Any]) → str[source]: Generate data report in Github flavored Markdown format.

generate_errors_report() → str[source]: Generate errors report in custom project-config format.

raise_errors(errors_report: Optional[str] = None) → None[source]

Raise errors failure if no success.

Raise the correspondent exception class for the reporter if the reporter has reported any error.

project_config.reporters.ghf_markdown.config_docs_markdown_link(key: str) → str[source]: Return the markdown link to the config docs.

project_config.reporters.ghf_markdown.config_docs_url_prefix() → str[source]: Return the URL to the config docs.

project_config.reporters.ghf_markdown.maybe_write_report_to_github_summary(report: str) → None[source]: Write report to Github summary if available.

project_config.reporters.ghf_markdown.plugin_or_verb_docs_url_prefix() → str[source]: Return the URL to the plugin docs.

project_config.reporters.ghf_markdown.styling_docs_url_prefix() → str[source]: Return the URL to the styling docs.