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_xml()
CodeBlockChecker.check_rst()
CodeBlockChecker.check_doctest()
CodeBlockChecker.check_bash()
CodeBlockChecker.check_c()
CodeBlockChecker.check_cpp()
- rstcheck_core.config module
CONFIG_FILES
ReportLevel
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()
RstcheckConfig
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
- rstcheck_core.runner module
- rstcheck_core.types module