diff --git a/docgen.sh b/docgen.sh index 75e473b3..c80e42f0 100755 --- a/docgen.sh +++ b/docgen.sh @@ -5,15 +5,19 @@ cd jc echo Building docs for: package pydoc-markdown -m jc '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' > ../docs/readme.md +sed -i "" 's/^#### /### /g' ../docs/readme.md echo Building docs for: lib pydoc-markdown -m jc.lib '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' > ../docs/lib.md +sed -i "" 's/^#### /### /g' ../docs/lib.md echo Building docs for: utils pydoc-markdown -m jc.utils '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' > ../docs/utils.md +sed -i "" 's/^#### /### /g' ../docs/utils.md echo Building docs for: universal parser pydoc-markdown -m jc.parsers.universal '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' > ../docs/parsers/universal.md +sed -i "" 's/^#### /### /g' ../docs/parsers/universal.md # a bit of inception here... jc is being used to help # automate the generation of its own documentation. :) diff --git a/docgen.sh.old b/docgen.sh.old deleted file mode 100755 index 022535c3..00000000 --- a/docgen.sh.old +++ /dev/null @@ -1,44 +0,0 @@ -#!/bin/bash -# Generate docs.md -# requires pydoc-markdown 2.1.0.post1 - -cd jc -echo Building docs for: package -pydocmd simple jc+ > ../docs/readme.md - -echo Building docs for: lib -pydocmd simple lib+ > ../docs/lib.md - -echo Building docs for: utils -pydocmd simple utils+ > ../docs/utils.md - -echo Building docs for: universal parser -pydocmd simple jc.parsers.universal+ > ../docs/parsers/universal.md - -# a bit of inception here... jc is being used to help -# automate the generation of its own documentation. :) - -# pull jc parser objects into a bash array from jq -parsers=() -while read -r value -do - parsers+=("$value") -done < <(jc -a | jq -c '.parsers[] | select(.plugin != true)') - -# iterate over the bash array -for parser in "${parsers[@]}" -do - parser_name=$(jq -r '.name' <<< "$parser") - 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 - pydocmd simple jc.parsers."${parser_name}"+ >> ../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 -done