From 331171b826f96cb8c29b27cf5c54b7ac85a9e819 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sun, 25 Sep 2022 12:38:17 -0700 Subject: [PATCH] optimize docgen --- docgen.sh | 28 ++++++++++++++-------------- docs/parsers/proc_net_arp.md | 2 +- jc/parsers/proc_net_arp.py | 2 +- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docgen.sh b/docgen.sh index ccdfcfb2..dee2f9b0 100755 --- a/docgen.sh +++ b/docgen.sh @@ -114,23 +114,23 @@ done < <(jc -a | jq -c '.parsers[] | select(.plugin != true)') for parser in "${parsers[@]}"; do parser_name=$(jq -r '.name' <<< "$parser") - if ! git diff --quiet --exit-code -- "parsers/${parser_name}.py"; then { - compatible=$(jq -r '.compatible | join(", ")' <<< "$parser") - version=$(jq -r '.version' <<< "$parser") - author=$(jq -r '.author' <<< "$parser") - author_email=$(jq -r '.author_email' <<< "$parser") + if ! git diff --quiet --exit-code -- "parsers/${parser_name}.py"; then + compatible=$(jq -r '.compatible | join(", ")' <<< "$parser") + version=$(jq -r '.version' <<< "$parser") + author=$(jq -r '.author' <<< "$parser") + author_email=$(jq -r '.author_email' <<< "$parser") - echo "Building docs for: ${parser_name}" - echo "[Home](https://kellyjonbrazil.github.io/jc/)" > ../docs/parsers/"${parser_name}".md - pydoc-markdown -m jc.parsers."${parser_name}" "${parser_config}" >> ../docs/parsers/"${parser_name}".md - echo "### Parser Information" >> ../docs/parsers/"${parser_name}".md - echo "Compatibility: ${compatible}" >> ../docs/parsers/"${parser_name}".md - echo >> ../docs/parsers/"${parser_name}".md - echo "Version ${version} by ${author} (${author_email})" >> ../docs/parsers/"${parser_name}".md - echo "+++ ${parser_name} docs complete" + echo "Building docs for: ${parser_name}" + echo "[Home](https://kellyjonbrazil.github.io/jc/)" > ../docs/parsers/"${parser_name}".md + pydoc-markdown -m jc.parsers."${parser_name}" "${parser_config}" >> ../docs/parsers/"${parser_name}".md + echo "### Parser Information" >> ../docs/parsers/"${parser_name}".md + echo "Compatibility: ${compatible}" >> ../docs/parsers/"${parser_name}".md + echo >> ../docs/parsers/"${parser_name}".md + echo "Version ${version} by ${author} (${author_email})" >> ../docs/parsers/"${parser_name}".md + echo "+++ ${parser_name} docs complete" + fi } & - fi done wait echo "Document Generation Complete" diff --git a/docs/parsers/proc_net_arp.md b/docs/parsers/proc_net_arp.md index c1eb30b2..0585b5ca 100644 --- a/docs/parsers/proc_net_arp.md +++ b/docs/parsers/proc_net_arp.md @@ -3,7 +3,7 @@ # jc.parsers.proc\_net\_arp -jc - JSON Convert `/proc/net/arp3` file parser +jc - JSON Convert `/proc/net/arp` file parser Usage (cli): diff --git a/jc/parsers/proc_net_arp.py b/jc/parsers/proc_net_arp.py index 8127e535..1535326d 100644 --- a/jc/parsers/proc_net_arp.py +++ b/jc/parsers/proc_net_arp.py @@ -1,4 +1,4 @@ -"""jc - JSON Convert `/proc/net/arp3` file parser +"""jc - JSON Convert `/proc/net/arp` file parser Usage (cli):