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

change header depth

Browse Source
This commit is contained in:
Kelly Brazil
2022-01-26 14:16:04 -08:00
parent 7028e87f9b
commit f8223023c3
4 changed files with 24 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docgen.sh
View File

@ -14,7 +14,14 @@ toc_config=$(cat <<'EOF'
], ],
"renderer": { "renderer": {
"type": "markdown", "type": "markdown",
"render_toc": true "render_toc": true,
"header_level_by_type": {
"Module": 1,
"Class": 3,
"Method": 3,
"Function": 3,
"Data": 3
}
} }
} }
EOF EOF
@ -32,7 +39,14 @@ config=$(cat <<'EOF'
} }
], ],
"renderer": { "renderer": {
"type": "markdown" "type": "markdown",
"header_level_by_type": {
"Module": 1,
"Class": 3,
"Method": 3,
"Function": 3,
"Data": 3
}
} }
} }
EOF EOF
@ -41,19 +55,19 @@ EOF
cd jc cd jc
echo Building docs for: package echo Building docs for: package
pydoc-markdown -m jc "${config}" > ../docs/readme.md pydoc-markdown -m jc "${config}" > ../docs/readme.md
sed -i "" 's/^#### /### /g' ../docs/readme.md # sed -i "" 's/^#### /### /g' ../docs/readme.md
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
sed -i "" 's/^#### /### /g' ../docs/lib.md # sed -i "" 's/^#### /### /g' ../docs/lib.md
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
sed -i "" 's/^#### /### /g' ../docs/utils.md # sed -i "" 's/^#### /### /g' ../docs/utils.md
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
sed -i "" 's/^#### /### /g' ../docs/parsers/universal.md # sed -i "" 's/^#### /### /g' ../docs/parsers/universal.md
# 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. :)
@ -81,5 +95,5 @@ 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
sed -i "" 's/^#### /### /g' ../docs/parsers/"${parser_name}".md # sed -i "" 's/^#### /### /g' ../docs/parsers/"${parser_name}".md
done done

2
docs/parsers/ifconfig.md
View File

@ -193,7 +193,7 @@ Examples:
<a id="jc.parsers.ifconfig._IfconfigParser"></a> <a id="jc.parsers.ifconfig._IfconfigParser"></a>
## \_IfconfigParser Objects ### \_IfconfigParser Objects
```python ```python
class _IfconfigParser(object) class _IfconfigParser(object)

2
docs/parsers/traceroute.md
View File

@ -157,7 +157,7 @@ SOFTWARE.
<a id="jc.parsers.traceroute._Hop"></a> <a id="jc.parsers.traceroute._Hop"></a>
## \_Hop Objects ### \_Hop Objects
```python ```python
class _Hop(object) class _Hop(object)

2
docs/utils.md
View File

@ -217,7 +217,7 @@ Ensure each line is a string
<a id="jc.utils.timestamp"></a> <a id="jc.utils.timestamp"></a>
## timestamp Objects ### timestamp Objects
```python ```python
class timestamp() class timestamp()