API

This part of the documentation covers the open API of rstcheck-core and is auto generated by sphinx-apidoc via sphinxcontrib-apidoc.

rst-source links (top right) do not work here, as auto generated api documentation files are discarded after build.

• rstcheck_core package
  • Submodules
  • rstcheck_core.checker module
    • check_file()
    • check_source()
    • CodeBlockChecker
      • CodeBlockChecker.language_is_supported()
      • CodeBlockChecker.create_checker()
      • CodeBlockChecker.check()
      • CodeBlockChecker.check_python()
      • CodeBlockChecker.check_json()
      • CodeBlockChecker.check_yaml()
      • CodeBlockChecker.check_xml()
      • CodeBlockChecker.check_rst()
      • CodeBlockChecker.check_doctest()
      • CodeBlockChecker.check_bash()
      • CodeBlockChecker.check_c()
      • CodeBlockChecker.check_cpp()
  • rstcheck_core.config module
    • CONFIG_FILES
    • ReportLevel
      • ReportLevel.INFO
      • ReportLevel.WARNING
      • ReportLevel.ERROR
      • ReportLevel.SEVERE
      • ReportLevel.NONE
    • ReportLevelMap
    • DEFAULT_REPORT_LEVEL
    • RstcheckConfigFile
      • RstcheckConfigFile.report_level
      • RstcheckConfigFile.ignore_directives
      • RstcheckConfigFile.ignore_roles
      • RstcheckConfigFile.ignore_substitutions
      • RstcheckConfigFile.ignore_languages
      • RstcheckConfigFile.ignore_messages
      • RstcheckConfigFile.valid_report_level()
      • RstcheckConfigFile.split_str()
      • RstcheckConfigFile.join_regex_str()
      • RstcheckConfigFile.model_config
    • RstcheckConfig
      • RstcheckConfig.config_path
      • RstcheckConfig.recursive
      • RstcheckConfig.warn_unknown_settings
      • RstcheckConfig.model_config
    • load_config_file()
    • load_config_file_from_dir()
    • load_config_file_from_dir_tree()
    • load_config_file_from_path()
    • merge_configs()
  • rstcheck_core.inline_config module
    • get_inline_config_from_source()
    • find_ignored_directives()
    • find_ignored_roles()
    • find_ignored_substitutions()
    • find_ignored_languages()
    • get_inline_flow_control_from_source()
    • find_code_block_ignore_lines()
  • rstcheck_core.runner module
    • RstcheckMainRunner
      • RstcheckMainRunner.files_to_check
      • RstcheckMainRunner.nonexisting_paths
      • RstcheckMainRunner.load_config_file()
      • RstcheckMainRunner.update_file_list()
      • RstcheckMainRunner.check()
      • RstcheckMainRunner.print_result()
      • RstcheckMainRunner.run()
  • rstcheck_core.types module
    • SourceFileOrString
    • LintError
      • LintError.source_origin
      • LintError.line_number
      • LintError.message
    • YieldedLintError
    • IgnoreDict
      • IgnoreDict.messages
      • IgnoreDict.languages
      • IgnoreDict.directives
      • IgnoreDict.roles
      • IgnoreDict.substitutions
    • construct_ignore_dict()
    • CheckerRunFunction
    • InlineConfig
      • InlineConfig.key
      • InlineConfig.value
    • InlineFlowControl
      • InlineFlowControl.value
      • InlineFlowControl.line_number