From ee1135003b9f5320b77854e2bec9f03b75e4667d Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sat, 16 Mar 2024 18:28:52 -0700 Subject: [PATCH] add space after bullets --- doc2md.py | 4 ++-- docs/lib.md | 22 +++++++++++----------- docs/parsers/universal.md | 6 +++--- docs/streaming.md | 14 +++++++------- docs/utils.md | 28 ++++++++++++++-------------- 5 files changed, 37 insertions(+), 37 deletions(-) diff --git a/doc2md.py b/doc2md.py index 57cfc7cb..c81a1623 100755 --- a/doc2md.py +++ b/doc2md.py @@ -42,9 +42,9 @@ for attribute in dir(module): functions.append(attribute) ######## TABLE OF CONTENTS ######## -toc = f'## Table of Contents\n\n*[{mod_path}](#{mod_path})\n' +toc = f'## Table of Contents\n\n* [{mod_path}](#{mod_path})\n' for api in functions: - toc = f'{toc} *[{api}](#{mod_path}.{api})\n' + toc = f'{toc} * [{api}](#{mod_path}.{api})\n' ######## API DOCS ######## api_docs = '' diff --git a/docs/lib.md b/docs/lib.md index abddc6cb..309444df 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -5,17 +5,17 @@ ## Table of Contents -*[jc.lib](#jc.lib) - *[all_parser_info](#jc.lib.all_parser_info) - *[get_help](#jc.lib.get_help) - *[get_parser](#jc.lib.get_parser) - *[parse](#jc.lib.parse) - *[parser_info](#jc.lib.parser_info) - *[parser_mod_list](#jc.lib.parser_mod_list) - *[plugin_parser_mod_list](#jc.lib.plugin_parser_mod_list) - *[slurpable_parser_mod_list](#jc.lib.slurpable_parser_mod_list) - *[standard_parser_mod_list](#jc.lib.standard_parser_mod_list) - *[streaming_parser_mod_list](#jc.lib.streaming_parser_mod_list) +* [jc.lib](#jc.lib) + * [all_parser_info](#jc.lib.all_parser_info) + * [get_help](#jc.lib.get_help) + * [get_parser](#jc.lib.get_parser) + * [parse](#jc.lib.parse) + * [parser_info](#jc.lib.parser_info) + * [parser_mod_list](#jc.lib.parser_mod_list) + * [plugin_parser_mod_list](#jc.lib.plugin_parser_mod_list) + * [slurpable_parser_mod_list](#jc.lib.slurpable_parser_mod_list) + * [standard_parser_mod_list](#jc.lib.standard_parser_mod_list) + * [streaming_parser_mod_list](#jc.lib.streaming_parser_mod_list) jc - JSON Convert lib module diff --git a/docs/parsers/universal.md b/docs/parsers/universal.md index d899daca..5f5b0967 100644 --- a/docs/parsers/universal.md +++ b/docs/parsers/universal.md @@ -5,9 +5,9 @@ ## Table of Contents -*[jc.parsers.universal](#jc.parsers.universal) - *[simple_table_parse](#jc.parsers.universal.simple_table_parse) - *[sparse_table_parse](#jc.parsers.universal.sparse_table_parse) +* [jc.parsers.universal](#jc.parsers.universal) + * [simple_table_parse](#jc.parsers.universal.simple_table_parse) + * [sparse_table_parse](#jc.parsers.universal.sparse_table_parse) jc - JSON Convert universal parsers diff --git a/docs/streaming.md b/docs/streaming.md index 0e216ebe..09ddb82c 100644 --- a/docs/streaming.md +++ b/docs/streaming.md @@ -5,13 +5,13 @@ ## Table of Contents -*[jc.streaming](#jc.streaming) - *[add_jc_meta](#jc.streaming.add_jc_meta) - *[raise_or_yield](#jc.streaming.raise_or_yield) - *[stream_error](#jc.streaming.stream_error) - *[stream_success](#jc.streaming.stream_success) - *[streaming_input_type_check](#jc.streaming.streaming_input_type_check) - *[streaming_line_input_type_check](#jc.streaming.streaming_line_input_type_check) +* [jc.streaming](#jc.streaming) + * [add_jc_meta](#jc.streaming.add_jc_meta) + * [raise_or_yield](#jc.streaming.raise_or_yield) + * [stream_error](#jc.streaming.stream_error) + * [stream_success](#jc.streaming.stream_success) + * [streaming_input_type_check](#jc.streaming.streaming_input_type_check) + * [streaming_line_input_type_check](#jc.streaming.streaming_line_input_type_check) jc - JSON Convert streaming utils diff --git a/docs/utils.md b/docs/utils.md index aa8da804..de07a4e4 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -5,20 +5,20 @@ ## Table of Contents -*[jc.utils](#jc.utils) - *[compatibility](#jc.utils.compatibility) - *[convert_size_to_int](#jc.utils.convert_size_to_int) - *[convert_to_bool](#jc.utils.convert_to_bool) - *[convert_to_float](#jc.utils.convert_to_float) - *[convert_to_int](#jc.utils.convert_to_int) - *[error_message](#jc.utils.error_message) - *[has_data](#jc.utils.has_data) - *[input_type_check](#jc.utils.input_type_check) - *[is_compatible](#jc.utils.is_compatible) - *[line_slice](#jc.utils.line_slice) - *[normalize_key](#jc.utils.normalize_key) - *[remove_quotes](#jc.utils.remove_quotes) - *[warning_message](#jc.utils.warning_message) +* [jc.utils](#jc.utils) + * [compatibility](#jc.utils.compatibility) + * [convert_size_to_int](#jc.utils.convert_size_to_int) + * [convert_to_bool](#jc.utils.convert_to_bool) + * [convert_to_float](#jc.utils.convert_to_float) + * [convert_to_int](#jc.utils.convert_to_int) + * [error_message](#jc.utils.error_message) + * [has_data](#jc.utils.has_data) + * [input_type_check](#jc.utils.input_type_check) + * [is_compatible](#jc.utils.is_compatible) + * [line_slice](#jc.utils.line_slice) + * [normalize_key](#jc.utils.normalize_key) + * [remove_quotes](#jc.utils.remove_quotes) + * [warning_message](#jc.utils.warning_message) jc - JSON Convert utils