Index

A

AbstractCommandDefinitionDocumentation (class in cminx.documentation_types) aggregator (cminx.documenter.Documenter attribute)

AttributeDocumentation (class in cminx.documentation_types) attributes (cminx.documentation_types.ClassDocumentation attribute)

B

build_doctest_string() (cminx.rstwriter.DocTest method) build_field_string() (cminx.rstwriter.Field method) build_heading() (cminx.rstwriter.Directive method) (cminx.rstwriter.RSTWriter method) build_heading_string() (cminx.rstwriter.DirectiveHeading method) (cminx.rstwriter.Heading method)

build_list_string() (cminx.rstwriter.RSTList method) build_option_string() (cminx.rstwriter.Option method) build_table_string() (cminx.rstwriter.SimpleTable method) build_text_string() (cminx.rstwriter.Paragraph method) BULLETED (cminx.rstwriter.ListType attribute) bulleted_list() (cminx.rstwriter.RSTWriter method)

C

ClassDocumentation (class in cminx.documentation_types) clear() (cminx.rstwriter.RSTWriter method) cmake.cminx module cmake.find_python_module module cmake.get_cmaize module cmake.get_cmake_test module cmake.get_version_from_git module cmake.python_virt_env module cmake.versions module CMakeSyntaxException cminx.aggregator module cminx.config module

cminx.documentation_types module cminx.documenter module cminx.exceptions module cminx.parser.CMakeLexer module cminx.parser.CMakeListener module cminx.parser.CMakeParser module cminx.parser.CMakeVisitor module cminx.rstwriter module cminx_gen_rst() (in module cmake.cminx) config_template() (in module cminx.config) constructors (cminx.documentation_types.ClassDocumentation attribute) consumed (cminx.aggregator.DocumentationAggregator attribute) CTestDocumentation (class in cminx.documentation_types)

D

DanglingDoccomment (class in cminx.documentation_types) default_value (cminx.documentation_types.AttributeDocumentation attribute) definition_command_stack (cminx.aggregator.DocumentationAggregator attribute) DefinitionCommand (class in cminx.aggregator) Directive (class in cminx.rstwriter) directive() (cminx.rstwriter.RSTWriter method) DirectiveHeading (class in cminx.rstwriter) doc (cminx.documentation_types.DocumentationType attribute) DocTest (class in cminx.rstwriter)

doctest() (cminx.rstwriter.RSTWriter method) document() (in module cminx) document_single_file() (in module cminx) documentation (cminx.aggregator.DefinitionCommand attribute) DocumentationAggregator (class in cminx.aggregator) DocumentationType (class in cminx.documentation_types) documented (cminx.aggregator.DocumentationAggregator attribute) documented_awaiting_function_def (cminx.aggregator.DocumentationAggregator attribute) documented_classes_stack (cminx.aggregator.DocumentationAggregator attribute) Documenter (class in cminx.documenter)

E

enterCommand_invocation() (cminx.aggregator.DocumentationAggregator method) enterDocumented_command() (cminx.aggregator.DocumentationAggregator method)

ENUMERATED (cminx.rstwriter.ListType attribute) enumerated_list() (cminx.rstwriter.RSTWriter method) expect_fail (cminx.documentation_types.TestDocumentation attribute)

F

Field (class in cminx.rstwriter) field() (cminx.rstwriter.RSTWriter method)

find_python_module() (in module cmake.find_python_module) format_arguments() (cminx.rstwriter.Directive method) FunctionDocumentation (class in cminx.documentation_types)

G

GenericCommandDocumentation (class in cminx.documentation_types) get_cmaize() (in module cmake.get_cmaize)

get_cmake_test() (in module cmake.get_cmake_test) get_indents() (in module cminx.rstwriter) get_version_from_git() (in module cmake.get_version_from_git)

H

has_kwargs (cminx.documentation_types.AbstractCommandDefinitionDocumentation attribute) Heading (class in cminx.rstwriter)

heading_level_chars (cminx.rstwriter.RSTWriter attribute) help_text (cminx.documentation_types.OptionDocumentation attribute)

I

inner_classes (cminx.documentation_types.ClassDocumentation attribute) input_stream (cminx.documenter.Documenter attribute) InputSettings (class in cminx.config)

interpreted_text() (in module cminx.rstwriter) is_constructor (cminx.documentation_types.MethodDocumentation attribute) is_macro (cminx.documentation_types.MethodDocumentation attribute) (cminx.documentation_types.TestDocumentation attribute)

L

lexer (cminx.documenter.Documenter attribute) line (cminx.exceptions.CMakeSyntaxException attribute)

LIST (cminx.documentation_types.VarType attribute) ListType (class in cminx.rstwriter) LoggingSettings (class in cminx.config)

M

MacroDocumentation (class in cminx.documentation_types) main() (in module cminx) make_python_venv() (in module cmake.python_virt_env) members (cminx.documentation_types.ClassDocumentation attribute) MethodDocumentation (class in cminx.documentation_types) module cmake.cminx cmake.find_python_module cmake.get_cmaize cmake.get_cmake_test cmake.get_version_from_git cmake.python_virt_env cmake.versions cminx.aggregator cminx.config cminx.documentation_types cminx.documenter cminx.exceptions cminx.parser.CMakeLexer cminx.parser.CMakeListener cminx.parser.CMakeParser cminx.parser.CMakeVisitor cminx.rstwriter

module (cminx.documenter.Documenter attribute) module_name (cminx.documenter.Documenter attribute) ModuleDocumentation (class in cminx.documentation_types) msg (cminx.exceptions.CMakeSyntaxException attribute)

N

name (cminx.documentation_types.DocumentationType attribute)

O

Option (class in cminx.rstwriter) option() (cminx.rstwriter.Directive method)

OptionDocumentation (class in cminx.documentation_types) OutputSettings (class in cminx.config)

P

Paragraph (class in cminx.rstwriter) param_types (cminx.documentation_types.MethodDocumentation attribute) params (cminx.documentation_types.AbstractCommandDefinitionDocumentation attribute) (cminx.documentation_types.GenericCommandDocumentation attribute) (cminx.documentation_types.MethodDocumentation attribute) (cminx.documentation_types.TestDocumentation attribute) parent_class (cminx.documentation_types.AttributeDocumentation attribute) (cminx.documentation_types.MethodDocumentation attribute) parser (cminx.documenter.Documenter attribute) process() (cminx.documentation_types.AttributeDocumentation method) (cminx.documentation_types.ClassDocumentation method) (cminx.documentation_types.CTestDocumentation method) (cminx.documentation_types.DanglingDoccomment method) (cminx.documentation_types.DocumentationType method) (cminx.documentation_types.FunctionDocumentation method) (cminx.documentation_types.GenericCommandDocumentation method) (cminx.documentation_types.MacroDocumentation method) (cminx.documentation_types.MethodDocumentation method) (cminx.documentation_types.ModuleDocumentation method) (cminx.documentation_types.OptionDocumentation method) (cminx.documentation_types.SectionDocumentation method) (cminx.documentation_types.TestDocumentation method) (cminx.documentation_types.VariableDocumentation method) (cminx.documenter.Documenter method)

process_add_test() (cminx.aggregator.DocumentationAggregator method) process_cmake_parse_arguments() (cminx.aggregator.DocumentationAggregator method) process_cpp_attr() (cminx.aggregator.DocumentationAggregator method) process_cpp_class() (cminx.aggregator.DocumentationAggregator method) process_cpp_constructor() (cminx.aggregator.DocumentationAggregator method) process_cpp_member() (cminx.aggregator.DocumentationAggregator method) process_ct_add_section() (cminx.aggregator.DocumentationAggregator method) process_ct_add_test() (cminx.aggregator.DocumentationAggregator method) process_docs() (cminx.documenter.Documenter method) process_function() (cminx.aggregator.DocumentationAggregator method) process_generic_command() (cminx.aggregator.DocumentationAggregator method) process_macro() (cminx.aggregator.DocumentationAggregator method) process_option() (cminx.aggregator.DocumentationAggregator method) process_set() (cminx.aggregator.DocumentationAggregator method) python_venv_pip_install() (in module cmake.python_virt_env)

R

RSTList (class in cminx.rstwriter)

RSTSettings (class in cminx.config) RSTWriter (class in cminx.rstwriter)

S

section() (cminx.rstwriter.RSTWriter method) SectionDocumentation (class in cminx.documentation_types) Settings (class in cminx.config) settings (cminx.aggregator.DocumentationAggregator attribute) (cminx.documenter.Documenter attribute)

should_document (cminx.aggregator.DefinitionCommand attribute) simple_table() (cminx.rstwriter.RSTWriter method) SimpleTable (class in cminx.rstwriter) stream (cminx.documenter.Documenter attribute) STRING (cminx.documentation_types.VarType attribute) superclasses (cminx.documentation_types.ClassDocumentation attribute)

T

TestDocumentation (class in cminx.documentation_types) text() (cminx.rstwriter.RSTWriter method)

to_text() (cminx.rstwriter.Directive method) (cminx.rstwriter.RSTWriter method) type (cminx.documentation_types.VariableDocumentation attribute)

U

UNSET (cminx.documentation_types.VarType attribute)

V

value (cminx.documentation_types.VariableDocumentation attribute)

VariableDocumentation (class in cminx.documentation_types) VarType (class in cminx.documentation_types)

W

walker (cminx.documenter.Documenter attribute)

write_to_file() (cminx.rstwriter.RSTWriter method) writer (cminx.documenter.Documenter attribute)