diff --git a/doc2md.py b/doc2md.py index d295aef1..57cfc7cb 100755 --- a/doc2md.py +++ b/doc2md.py @@ -7,7 +7,6 @@ import sys import importlib from inspect import isfunction, signature, cleandoc import yapf # type: ignore -import sys ignore_lib_functions = [ 'cast', diff --git a/docgen.sh b/docgen.sh index 990add17..d5d876e1 100755 --- a/docgen.sh +++ b/docgen.sh @@ -1,34 +1,32 @@ #!/bin/bash # Generate markdown document files (*.md) - # Requires the yapf python library - # use ./docgen all to generate all docs cd jc ( echo Building docs for: package - ../doc2md.py jc > ../docs/readme.md && echo "+++ package docs complete" || echo "*** PACKAGE DOCS FAILED" + ../doc2md.py jc > ../docs/readme.md && echo "+++ package docs complete" || echo "*** PACKAGE DOCS FAILED ***" ) & ( echo Building docs for: lib - ../doc2md.py jc.lib > ../docs/lib.md && echo "+++ lib docs complete" || echo "*** LIB DOCS FAILED" + ../doc2md.py jc.lib > ../docs/lib.md && echo "+++ lib docs complete" || echo "*** LIB DOCS FAILED ***" ) & ( echo Building docs for: utils - ../doc2md.py jc.utils > ../docs/utils.md && echo "+++ utils docs complete" || echo "*** UTILS DOCS FAILED" + ../doc2md.py jc.utils > ../docs/utils.md && echo "+++ utils docs complete" || echo "*** UTILS DOCS FAILED ***" ) & ( echo Building docs for: streaming - ../doc2md.py jc.streaming > ../docs/streaming.md && echo "+++ streaming docs complete" || echo "*** STREAMING DOCS FAILED" + ../doc2md.py jc.streaming > ../docs/streaming.md && echo "+++ streaming docs complete" || echo "*** STREAMING DOCS FAILED ***" ) & ( echo Building docs for: universal parser - ../doc2md.py jc.parsers.universal > ../docs/parsers/universal.md && echo "+++ universal parser docs complete" || echo "*** UNIVERSAL PARSER DOCS FAILED" + ../doc2md.py jc.parsers.universal > ../docs/parsers/universal.md && echo "+++ universal parser docs complete" || echo "*** UNIVERSAL PARSER DOCS FAILED ***" ) & # a bit of inception here... jc is being used to help @@ -47,7 +45,7 @@ for parser in "${parsers[@]}"; do { if [[ $1 == "all" ]] || ! git diff --quiet --exit-code HEAD~5 -- "parsers/${parser_name}.py"; then echo "Building docs for: ${parser_name}" - ../doc2md.py jc.parsers."${parser_name}" > ../docs/parsers/"${parser_name}".md && echo "+++ ${parser_name} docs complete" || echo "*** ${parser_name} DOCS FAILED" + ../doc2md.py jc.parsers."${parser_name}" > ../docs/parsers/"${parser_name}".md && echo "+++ ${parser_name} docs complete" || echo "*** ${parser_name} DOCS FAILED ***" fi } & done