test_autodoc module

class test_autodoc.SchemaWithQuotedDescriptions(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: argschema.schemas.ArgSchema

This schema is designed to be a schema_type for an ArgSchemaParser object

SchemaWithQuotedDescriptions

key	description	default	field_type	json_type
input_json	file path of input json file	NA	InputFile	str
output_json	file path to output json file	NA	OutputFile	str
log_level	set the logging level of the module	ERROR	LogLevel	str
a	something that is ‘quoted’ is problematic	(REQUIRED)	Integer	int

opts = <marshmallow.schema.SchemaOpts object>

test_autodoc.test_autodoc()

test_autodoc.test_autodoc_argschemaparser()

test_autodoc.test_autodoc_list()

test_autodoc.test_autodoc_myparser()

test_autodoc.test_autodoc_nested()

test_autodoc.test_autodoc_quotes()

test_autodoc.test_autodoc_recursive_nested()

test_autodoc.test_autodoc_slice()

test_autodoc.validate_rst_lines(lines, level=2)

validates a set of lines that would make up an rst file using rstcheck

Parameters:

• lines (list[str]) – a list of lines that would compose some restructuredText
• level (docutils.utils.Reporter.WARNING_LEVEL) – the reporting level to hold this to

Returns:

Return type:

None

Raises:

AssertionError – If the lines contain any errors above the level