diff --git a/docgen.sh b/docgen.sh index 3a851601..0795d47c 100755 --- a/docgen.sh +++ b/docgen.sh @@ -14,7 +14,14 @@ toc_config=$(cat <<'EOF' ], "renderer": { "type": "markdown", - "render_toc": true + "render_toc": true, + "header_level_by_type": { + "Module": 1, + "Class": 3, + "Method": 3, + "Function": 3, + "Data": 3 + } } } EOF @@ -32,7 +39,14 @@ config=$(cat <<'EOF' } ], "renderer": { - "type": "markdown" + "type": "markdown", + "header_level_by_type": { + "Module": 1, + "Class": 3, + "Method": 3, + "Function": 3, + "Data": 3 + } } } EOF @@ -41,19 +55,19 @@ EOF cd jc echo Building docs for: package 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 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 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 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 # automate the generation of its own documentation. :) @@ -81,5 +95,5 @@ do 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 - sed -i "" 's/^#### /### /g' ../docs/parsers/"${parser_name}".md + # sed -i "" 's/^#### /### /g' ../docs/parsers/"${parser_name}".md done diff --git a/docs/parsers/ifconfig.md b/docs/parsers/ifconfig.md index c64b3c63..8bd01420 100644 --- a/docs/parsers/ifconfig.md +++ b/docs/parsers/ifconfig.md @@ -193,7 +193,7 @@ Examples: -## \_IfconfigParser Objects +### \_IfconfigParser Objects ```python class _IfconfigParser(object) diff --git a/docs/parsers/traceroute.md b/docs/parsers/traceroute.md index e1fbde83..25657190 100644 --- a/docs/parsers/traceroute.md +++ b/docs/parsers/traceroute.md @@ -157,7 +157,7 @@ SOFTWARE. -## \_Hop Objects +### \_Hop Objects ```python class _Hop(object) diff --git a/docs/utils.md b/docs/utils.md index ac60439a..31b6f49d 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -217,7 +217,7 @@ Ensure each line is a string -## timestamp Objects +### timestamp Objects ```python class timestamp()