Index

A

add_eol() (in module docstripy.lines_routines) add_indent() (in module docstripy.lines_routines)

apply_diff() (in module docstripy.difference) are_lines_class_head() (in module docstripy.parse_doc.signature)

B

break_sentences() (in module docstripy.line_break) build_doc_google() (in module docstripy.google.build_doc) build_doc_numpy() (in module docstripy.numpy.build_doc) build_doc_rest() (in module docstripy.rest.build_doc)

build_docstring() (in module docstripy.build_doc.main_builder) build_section_params_google() (in module docstripy.google.build_doc) build_section_params_numpy() (in module docstripy.numpy.build_doc) build_section_params_rest() (in module docstripy.rest.build_doc)

C

clean_comment() (in module docstripy.lines_routines) clean_empty_param_section() (in module docstripy.parse_doc.main_parser) clean_empty_sections() (in module docstripy.parse_doc.main_parser)

clean_leading_empty() (in module docstripy.lines_routines) clean_section_ranges() (in module docstripy.parse_doc.section_ranges) clean_trailing_empty() (in module docstripy.lines_routines) clean_trailing_spaces() (in module docstripy.lines_routines)

D

def_parse_range() (in module docstripy.file_parser) delimit_section_ranges() (in module docstripy.parse_doc.section_ranges) docstring_parse_range() (in module docstripy.file_parser) docstripy.build_doc.main_builder module docstripy.build_doc.preprocessing module docstripy.difference module docstripy.file_parser module docstripy.google.build_doc module docstripy.google.parse_doc module docstripy.line_break module docstripy.lines_routines module docstripy.main module

docstripy.numpy.build_doc module docstripy.numpy.parse_doc module docstripy.parse_doc.main_parser module docstripy.parse_doc.parse_params module docstripy.parse_doc.parse_signature module docstripy.parse_doc.postprocessing module docstripy.parse_doc.section_ranges module docstripy.parse_doc.signature module docstripy.rest.build_doc module docstripy.rest.parse_doc module docstripy.write module

E

extract_default_value() (in module docstripy.parse_doc.parse_params)

F

find_indent() (in module docstripy.lines_routines)

find_prefix() (in module docstripy.lines_routines) find_range_matching() (in module docstripy.parse_doc.signature)

G

generate_new_file() (in module docstripy.write)

I

is_def_line() (in module docstripy.file_parser)

is_define_section() (in module docstripy.google.parse_doc)

L

line_break() (in module docstripy.line_break)

M

main() (in module docstripy.main) make_title_from_func_name() (in module docstripy.parse_doc.signature) merge_docstr_signature() (in module docstripy.parse_doc.signature) module docstripy.build_doc.main_builder docstripy.build_doc.preprocessing docstripy.difference docstripy.file_parser docstripy.google.build_doc docstripy.google.parse_doc docstripy.line_break docstripy.lines_routines docstripy.main docstripy.numpy.build_doc docstripy.numpy.parse_doc docstripy.parse_doc.main_parser docstripy.parse_doc.parse_params docstripy.parse_doc.parse_signature docstripy.parse_doc.postprocessing docstripy.parse_doc.section_ranges docstripy.parse_doc.signature docstripy.rest.build_doc docstripy.rest.parse_doc docstripy.write

O

order_lists() (in module docstripy.difference)

P

parse_all() (in module docstripy.parse_doc.main_parser) parse_args() (in module docstripy.main) parse_docstring() (in module docstripy.parse_doc.main_parser) parse_params() (in module docstripy.google.parse_doc) (in module docstripy.numpy.parse_doc) (in module docstripy.rest.parse_doc) parse_params_all() (in module docstripy.parse_doc.parse_params) parse_ranges() (in module docstripy.file_parser) parse_sections_ranges() (in module docstripy.google.parse_doc) (in module docstripy.numpy.parse_doc) (in module docstripy.parse_doc.section_ranges) (in module docstripy.rest.parse_doc)

parse_signature() (in module docstripy.parse_doc.parse_signature) parse_signature_args() (in module docstripy.parse_doc.parse_signature) parse_wild_sections_ranges() (in module docstripy.google.parse_doc) (in module docstripy.numpy.parse_doc) postprocess_default_val() (in module docstripy.parse_doc.postprocessing) postprocess_description() (in module docstripy.parse_doc.postprocessing) postprocess_title_parse() (in module docstripy.parse_doc.postprocessing) preprocess_title_build() (in module docstripy.build_doc.preprocessing)

R

remove_indent() (in module docstripy.lines_routines)

remove_quotes() (in module docstripy.lines_routines)

S

satenize_ranges() (in module docstripy.difference) split_comma() (in module docstripy.parse_doc.parse_signature)

split_first_line() (in module docstripy.lines_routines) split_line() (in module docstripy.difference)

W

write_file_ipynb() (in module docstripy.write)

write_file_py() (in module docstripy.write) write_files_recursive() (in module docstripy.write)