python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-07-15 01:24:29 +02:00
Code Issues Releases Activity

optimize docgen

Browse Source
This commit is contained in:
Kelly Brazil
2022-09-25 12:38:17 -07:00
parent 1d9965dad6
commit 331171b826
3 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docgen.sh
View File

@ -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"

2
docs/parsers/proc_net_arp.md
View File

@ -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):

2
jc/parsers/proc_net_arp.py
View File

@ -1,4 +1,4 @@
"""jc - JSON Convert `/proc/net/arp3` file parser
"""jc - JSON Convert `/proc/net/arp` file parser
Usage (cli):