python/jc
1
0
Fork 0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00
Code Issues Releases Activity

parallelize doc gneration

Browse Source
This commit is contained in:
Kelly Brazil
2022-04-10 16:54:22 -07:00
parent 585bf0e159
commit 45342ea9fe
2 changed files with 16 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docgen.sh
View File

@ -77,19 +77,19 @@ EOF
cd jc cd jc
echo Building docs for: package echo Building docs for: package
pydoc-markdown -m jc "${readme_config}" > ../docs/readme.md pydoc-markdown -m jc "${readme_config}" > ../docs/readme.md; echo "+++ package docs complete" &
echo Building docs for: lib echo Building docs for: lib
pydoc-markdown -m jc.lib "${toc_config}" > ../docs/lib.md pydoc-markdown -m jc.lib "${toc_config}" > ../docs/lib.md; echo "+++ lib docs complete" &
echo Building docs for: utils echo Building docs for: utils
pydoc-markdown -m jc.utils "${toc_config}" > ../docs/utils.md pydoc-markdown -m jc.utils "${toc_config}" > ../docs/utils.md; echo "+++ utils docs complete" &
echo Building docs for: streaming echo Building docs for: streaming
pydoc-markdown -m jc.streaming "${toc_config}" > ../docs/streaming.md pydoc-markdown -m jc.streaming "${toc_config}" > ../docs/streaming.md; echo "+++ streaming docs complete" &
echo Building docs for: universal parser echo Building docs for: universal parser
pydoc-markdown -m jc.parsers.universal "${toc_config}" > ../docs/parsers/universal.md pydoc-markdown -m jc.parsers.universal "${toc_config}" > ../docs/parsers/universal.md; echo "+++ universal parser docs complete" &
# a bit of inception here... jc is being used to help # a bit of inception here... jc is being used to help
# automate the generation of its own documentation. :) # automate the generation of its own documentation. :)
@ -103,7 +103,7 @@ do
done < <(jc -a | jq -c '.parsers[] | select(.plugin != true)') done < <(jc -a | jq -c '.parsers[] | select(.plugin != true)')
for parser in "${parsers[@]}" for parser in "${parsers[@]}"
do do (
parser_name=$(jq -r '.name' <<< "$parser") parser_name=$(jq -r '.name' <<< "$parser")
compatible=$(jq -r '.compatible | join(", ")' <<< "$parser") compatible=$(jq -r '.compatible | join(", ")' <<< "$parser")
version=$(jq -r '.version' <<< "$parser") version=$(jq -r '.version' <<< "$parser")
@ -117,4 +117,8 @@ do
echo "Compatibility: ${compatible}" >> ../docs/parsers/"${parser_name}".md echo "Compatibility: ${compatible}" >> ../docs/parsers/"${parser_name}".md
echo >> ../docs/parsers/"${parser_name}".md echo >> ../docs/parsers/"${parser_name}".md
echo "Version ${version} by ${author} (${author_email})" >> ../docs/parsers/"${parser_name}".md echo "Version ${version} by ${author} (${author_email})" >> ../docs/parsers/"${parser_name}".md
echo "+++ ${parser_name} docs complete"
) &
done done
wait
echo "Document Generation Complete"

9
updatedocs.sh
View File

@ -2,10 +2,13 @@
# Update all documentation (README.md, Man page, Doc files) # Update all documentation (README.md, Man page, Doc files)
echo === Building README.md echo === Building README.md
./readmegen.py && echo "+++ README.md build successful" || echo "--- README.md build failed" ./readmegen.py && echo "+++ README.md build successful" || echo "--- README.md build failed" &
echo === Building man page echo === Building man page
./mangen.py && echo "+++ man page build successful" || echo "--- man page build failed" ./mangen.py && echo "+++ man page build successful" || echo "--- man page build failed" &
echo === Building documentation echo === Building documentation
./docgen.sh && echo "+++ documentation build successful" || echo "--- documentation build failed" ./docgen.sh && echo "+++ documentation build successful" || echo "--- documentation build failed" &
wait
echo "All documentation Updated"