From 590728f9c1ccfdc078e600d1f35ad4ba51f70d36 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 26 Jan 2022 11:50:25 -0800 Subject: [PATCH] try new pydoc-markdown formatting options --- docgen.sh | 28 +++++++++++++++++++++++----- docs/lib.md | 13 ++++++++++--- docs/parsers/acpi.md | 5 +++++ docs/parsers/airport.md | 5 +++++ docs/parsers/airport_s.md | 5 +++++ docs/parsers/arp.md | 5 +++++ docs/parsers/blkid.md | 5 +++++ docs/parsers/cksum.md | 5 +++++ docs/parsers/crontab.md | 5 +++++ docs/parsers/crontab_u.md | 5 +++++ docs/parsers/csv.md | 5 +++++ docs/parsers/csv_s.md | 5 +++++ docs/parsers/date.md | 5 +++++ docs/parsers/df.md | 5 +++++ docs/parsers/dig.md | 5 +++++ docs/parsers/dir.md | 5 +++++ docs/parsers/dmidecode.md | 5 +++++ docs/parsers/dpkg_l.md | 5 +++++ docs/parsers/du.md | 5 +++++ docs/parsers/env.md | 5 +++++ docs/parsers/file.md | 5 +++++ docs/parsers/finger.md | 5 +++++ docs/parsers/free.md | 5 +++++ docs/parsers/fstab.md | 5 +++++ docs/parsers/group.md | 5 +++++ docs/parsers/gshadow.md | 5 +++++ docs/parsers/hash.md | 5 +++++ docs/parsers/hashsum.md | 5 +++++ docs/parsers/hciconfig.md | 5 +++++ docs/parsers/history.md | 5 +++++ docs/parsers/hosts.md | 5 +++++ docs/parsers/id.md | 5 +++++ docs/parsers/ifconfig.md | 14 ++++++++++++++ docs/parsers/ini.md | 5 +++++ docs/parsers/iostat.md | 5 +++++ docs/parsers/iostat_s.md | 5 +++++ docs/parsers/iptables.md | 5 +++++ docs/parsers/iw_scan.md | 5 +++++ docs/parsers/jar_manifest.md | 5 +++++ docs/parsers/jobs.md | 5 +++++ docs/parsers/kv.md | 5 +++++ docs/parsers/last.md | 5 +++++ docs/parsers/ls.md | 5 +++++ docs/parsers/ls_s.md | 5 +++++ docs/parsers/lsblk.md | 5 +++++ docs/parsers/lsmod.md | 5 +++++ docs/parsers/lsof.md | 5 +++++ docs/parsers/lsusb.md | 5 +++++ docs/parsers/mount.md | 5 +++++ docs/parsers/netstat.md | 5 +++++ docs/parsers/ntpq.md | 5 +++++ docs/parsers/passwd.md | 5 +++++ docs/parsers/ping.md | 5 +++++ docs/parsers/ping_s.md | 5 +++++ docs/parsers/pip_list.md | 5 +++++ docs/parsers/pip_show.md | 5 +++++ docs/parsers/ps.md | 5 +++++ docs/parsers/route.md | 5 +++++ docs/parsers/rpm_qi.md | 5 +++++ docs/parsers/sfdisk.md | 5 +++++ docs/parsers/shadow.md | 5 +++++ docs/parsers/ss.md | 5 +++++ docs/parsers/stat.md | 5 +++++ docs/parsers/stat_s.md | 5 +++++ docs/parsers/sysctl.md | 5 +++++ docs/parsers/systemctl.md | 5 +++++ docs/parsers/systemctl_lj.md | 5 +++++ docs/parsers/systemctl_ls.md | 5 +++++ docs/parsers/systemctl_luf.md | 5 +++++ docs/parsers/systeminfo.md | 5 +++++ docs/parsers/time.md | 5 +++++ docs/parsers/timedatectl.md | 5 +++++ docs/parsers/tracepath.md | 5 +++++ docs/parsers/traceroute.md | 8 ++++++++ docs/parsers/ufw.md | 5 +++++ docs/parsers/ufw_appinfo.md | 5 +++++ docs/parsers/uname.md | 5 +++++ docs/parsers/universal.md | 6 ++++++ docs/parsers/upower.md | 5 +++++ docs/parsers/uptime.md | 5 +++++ docs/parsers/vmstat.md | 5 +++++ docs/parsers/vmstat_s.md | 5 +++++ docs/parsers/w.md | 5 +++++ docs/parsers/wc.md | 5 +++++ docs/parsers/who.md | 5 +++++ docs/parsers/xml.md | 5 +++++ docs/parsers/yaml.md | 5 +++++ docs/parsers/zipinfo.md | 5 +++++ docs/readme.md | 4 ++++ docs/utils.md | 17 +++++++++++++++++ jc/lib.py | 18 +++++++++--------- 91 files changed, 506 insertions(+), 17 deletions(-) diff --git a/docgen.sh b/docgen.sh index c80e42f0..1457ac7b 100755 --- a/docgen.sh +++ b/docgen.sh @@ -1,22 +1,40 @@ #!/bin/bash # Generate docs.md # requires pydoc-markdown 4.5.0 +config=$(cat <<'EOF' +{ + "processors": [ + { + "type": "filter", + "expression":"not name ==\"info\" and default()" + }, + { + "type": "pydocmd" + } + ], + "renderer": { + "type": "markdown", + "render_toc": true + } +} +EOF +) 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 +pydoc-markdown -m jc "${config}" > ../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 +pydoc-markdown -m jc.lib "${config}" > ../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 +pydoc-markdown -m jc.utils "${config}" > ../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 +pydoc-markdown -m jc.parsers.universal "${config}" > ../docs/parsers/universal.md sed -i "" 's/^#### /### /g' ../docs/parsers/universal.md # a bit of inception here... jc is being used to help @@ -40,7 +58,7 @@ do 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}" '{"processors":[{"type":"filter","expression":"not name ==\"info\" and default()"},{"type":"pydocmd"}]}' >> ../docs/parsers/"${parser_name}".md + pydoc-markdown -m jc.parsers."${parser_name}" "${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 diff --git a/docs/lib.md b/docs/lib.md index b386767e..afbf22d9 100644 --- a/docs/lib.md +++ b/docs/lib.md @@ -1,3 +1,12 @@ +# Table of Contents + +* [jc.lib](#jc.lib) + * [parse](#jc.lib.parse) + * [parser\_mod\_list](#jc.lib.parser_mod_list) + * [plugin\_parser\_mod\_list](#jc.lib.plugin_parser_mod_list) + * [parser\_info](#jc.lib.parser_info) + * [get\_help](#jc.lib.get_help) + # jc.lib @@ -10,9 +19,7 @@ JC lib module ### parse ```python -def parse(parser_mod_name: str, data: Union[str, Iterable[str]], quiet: Optional[bool] = False, raw: Optional[bool] = False, ignore_exceptions: Optional[Union[None, bool]] = None, **kwargs: Any, ,) -> Union[Dict[str, Any], - List[Dict[str, Any]], - Iterator[Dict[str, Any]]] +def parse(parser_mod_name: str, data: Union[str, Iterable[str]], quiet: Optional[bool] = False, raw: Optional[bool] = False, ignore_exceptions: Optional[Union[None, bool]] = None, **kwargs: Any, ,) -> Union[Dict[str, Any], List[Dict[str, Any]], Iterator[Dict[str, Any]]] ``` Parse the string data using the supplied parser module. diff --git a/docs/parsers/acpi.md b/docs/parsers/acpi.md index d6adf5a8..987c2ee2 100644 --- a/docs/parsers/acpi.md +++ b/docs/parsers/acpi.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.acpi](#jc.parsers.acpi) + * [parse](#jc.parsers.acpi.parse) + # jc.parsers.acpi diff --git a/docs/parsers/airport.md b/docs/parsers/airport.md index 24abb893..4be82b4d 100644 --- a/docs/parsers/airport.md +++ b/docs/parsers/airport.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.airport](#jc.parsers.airport) + * [parse](#jc.parsers.airport.parse) + # jc.parsers.airport diff --git a/docs/parsers/airport_s.md b/docs/parsers/airport_s.md index ae9afae4..0a1acbc4 100644 --- a/docs/parsers/airport_s.md +++ b/docs/parsers/airport_s.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.airport\_s](#jc.parsers.airport_s) + * [parse](#jc.parsers.airport_s.parse) + # jc.parsers.airport\_s diff --git a/docs/parsers/arp.md b/docs/parsers/arp.md index 09ca6d08..25f7d227 100644 --- a/docs/parsers/arp.md +++ b/docs/parsers/arp.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.arp](#jc.parsers.arp) + * [parse](#jc.parsers.arp.parse) + # jc.parsers.arp diff --git a/docs/parsers/blkid.md b/docs/parsers/blkid.md index b94411f2..2b3851cb 100644 --- a/docs/parsers/blkid.md +++ b/docs/parsers/blkid.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.blkid](#jc.parsers.blkid) + * [parse](#jc.parsers.blkid.parse) + # jc.parsers.blkid diff --git a/docs/parsers/cksum.md b/docs/parsers/cksum.md index 0ba7468e..1cca42aa 100644 --- a/docs/parsers/cksum.md +++ b/docs/parsers/cksum.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.cksum](#jc.parsers.cksum) + * [parse](#jc.parsers.cksum.parse) + # jc.parsers.cksum diff --git a/docs/parsers/crontab.md b/docs/parsers/crontab.md index d4f518b6..6b155f26 100644 --- a/docs/parsers/crontab.md +++ b/docs/parsers/crontab.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.crontab](#jc.parsers.crontab) + * [parse](#jc.parsers.crontab.parse) + # jc.parsers.crontab diff --git a/docs/parsers/crontab_u.md b/docs/parsers/crontab_u.md index 718cb49a..53441c77 100644 --- a/docs/parsers/crontab_u.md +++ b/docs/parsers/crontab_u.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.crontab\_u](#jc.parsers.crontab_u) + * [parse](#jc.parsers.crontab_u.parse) + # jc.parsers.crontab\_u diff --git a/docs/parsers/csv.md b/docs/parsers/csv.md index 95656d8e..24f23143 100644 --- a/docs/parsers/csv.md +++ b/docs/parsers/csv.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.csv](#jc.parsers.csv) + * [parse](#jc.parsers.csv.parse) + # jc.parsers.csv diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md index eee33fae..835b617a 100644 --- a/docs/parsers/csv_s.md +++ b/docs/parsers/csv_s.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.csv\_s](#jc.parsers.csv_s) + * [parse](#jc.parsers.csv_s.parse) + # jc.parsers.csv\_s diff --git a/docs/parsers/date.md b/docs/parsers/date.md index 5e2f4d42..6d6b0d4b 100644 --- a/docs/parsers/date.md +++ b/docs/parsers/date.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.date](#jc.parsers.date) + * [parse](#jc.parsers.date.parse) + # jc.parsers.date diff --git a/docs/parsers/df.md b/docs/parsers/df.md index 4e787857..eefb5f83 100644 --- a/docs/parsers/df.md +++ b/docs/parsers/df.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.df](#jc.parsers.df) + * [parse](#jc.parsers.df.parse) + # jc.parsers.df diff --git a/docs/parsers/dig.md b/docs/parsers/dig.md index fa3d492d..438dc7e6 100644 --- a/docs/parsers/dig.md +++ b/docs/parsers/dig.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.dig](#jc.parsers.dig) + * [parse](#jc.parsers.dig.parse) + # jc.parsers.dig diff --git a/docs/parsers/dir.md b/docs/parsers/dir.md index db4651c9..dd352a3f 100644 --- a/docs/parsers/dir.md +++ b/docs/parsers/dir.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.dir](#jc.parsers.dir) + * [parse](#jc.parsers.dir.parse) + # jc.parsers.dir diff --git a/docs/parsers/dmidecode.md b/docs/parsers/dmidecode.md index 8591a534..53e1045f 100644 --- a/docs/parsers/dmidecode.md +++ b/docs/parsers/dmidecode.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.dmidecode](#jc.parsers.dmidecode) + * [parse](#jc.parsers.dmidecode.parse) + # jc.parsers.dmidecode diff --git a/docs/parsers/dpkg_l.md b/docs/parsers/dpkg_l.md index 0daa5f96..b8ce6d6b 100644 --- a/docs/parsers/dpkg_l.md +++ b/docs/parsers/dpkg_l.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.dpkg\_l](#jc.parsers.dpkg_l) + * [parse](#jc.parsers.dpkg_l.parse) + # jc.parsers.dpkg\_l diff --git a/docs/parsers/du.md b/docs/parsers/du.md index 6168bfda..faf8347d 100644 --- a/docs/parsers/du.md +++ b/docs/parsers/du.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.du](#jc.parsers.du) + * [parse](#jc.parsers.du.parse) + # jc.parsers.du diff --git a/docs/parsers/env.md b/docs/parsers/env.md index 428f02d1..3e8fc8bc 100644 --- a/docs/parsers/env.md +++ b/docs/parsers/env.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.env](#jc.parsers.env) + * [parse](#jc.parsers.env.parse) + # jc.parsers.env diff --git a/docs/parsers/file.md b/docs/parsers/file.md index aefb2165..f19944cd 100644 --- a/docs/parsers/file.md +++ b/docs/parsers/file.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.file](#jc.parsers.file) + * [parse](#jc.parsers.file.parse) + # jc.parsers.file diff --git a/docs/parsers/finger.md b/docs/parsers/finger.md index a48edaa9..2b8d5431 100644 --- a/docs/parsers/finger.md +++ b/docs/parsers/finger.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.finger](#jc.parsers.finger) + * [parse](#jc.parsers.finger.parse) + # jc.parsers.finger diff --git a/docs/parsers/free.md b/docs/parsers/free.md index 4e3fa757..00f64316 100644 --- a/docs/parsers/free.md +++ b/docs/parsers/free.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.free](#jc.parsers.free) + * [parse](#jc.parsers.free.parse) + # jc.parsers.free diff --git a/docs/parsers/fstab.md b/docs/parsers/fstab.md index 4d4707ec..b035fa14 100644 --- a/docs/parsers/fstab.md +++ b/docs/parsers/fstab.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.fstab](#jc.parsers.fstab) + * [parse](#jc.parsers.fstab.parse) + # jc.parsers.fstab diff --git a/docs/parsers/group.md b/docs/parsers/group.md index 14037ccc..8da19cf5 100644 --- a/docs/parsers/group.md +++ b/docs/parsers/group.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.group](#jc.parsers.group) + * [parse](#jc.parsers.group.parse) + # jc.parsers.group diff --git a/docs/parsers/gshadow.md b/docs/parsers/gshadow.md index d70b01ca..bce9568c 100644 --- a/docs/parsers/gshadow.md +++ b/docs/parsers/gshadow.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.gshadow](#jc.parsers.gshadow) + * [parse](#jc.parsers.gshadow.parse) + # jc.parsers.gshadow diff --git a/docs/parsers/hash.md b/docs/parsers/hash.md index 319591d2..3ec79ff5 100644 --- a/docs/parsers/hash.md +++ b/docs/parsers/hash.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.hash](#jc.parsers.hash) + * [parse](#jc.parsers.hash.parse) + # jc.parsers.hash diff --git a/docs/parsers/hashsum.md b/docs/parsers/hashsum.md index a2ca926c..56d5b4f4 100644 --- a/docs/parsers/hashsum.md +++ b/docs/parsers/hashsum.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.hashsum](#jc.parsers.hashsum) + * [parse](#jc.parsers.hashsum.parse) + # jc.parsers.hashsum diff --git a/docs/parsers/hciconfig.md b/docs/parsers/hciconfig.md index 7a486eb6..e30452e2 100644 --- a/docs/parsers/hciconfig.md +++ b/docs/parsers/hciconfig.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.hciconfig](#jc.parsers.hciconfig) + * [parse](#jc.parsers.hciconfig.parse) + # jc.parsers.hciconfig diff --git a/docs/parsers/history.md b/docs/parsers/history.md index 54ce0dea..6ddb86f3 100644 --- a/docs/parsers/history.md +++ b/docs/parsers/history.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.history](#jc.parsers.history) + * [parse](#jc.parsers.history.parse) + # jc.parsers.history diff --git a/docs/parsers/hosts.md b/docs/parsers/hosts.md index 9b9d165b..8fcdf8b2 100644 --- a/docs/parsers/hosts.md +++ b/docs/parsers/hosts.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.hosts](#jc.parsers.hosts) + * [parse](#jc.parsers.hosts.parse) + # jc.parsers.hosts diff --git a/docs/parsers/id.md b/docs/parsers/id.md index f231d485..62f82703 100644 --- a/docs/parsers/id.md +++ b/docs/parsers/id.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.id](#jc.parsers.id) + * [parse](#jc.parsers.id.parse) + # jc.parsers.id diff --git a/docs/parsers/ifconfig.md b/docs/parsers/ifconfig.md index c64b3c63..7ba7c3dc 100644 --- a/docs/parsers/ifconfig.md +++ b/docs/parsers/ifconfig.md @@ -1,4 +1,18 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ifconfig](#jc.parsers.ifconfig) + * [\_IfconfigParser](#jc.parsers.ifconfig._IfconfigParser) + * [\_\_init\_\_](#jc.parsers.ifconfig._IfconfigParser.__init__) + * [list\_interfaces](#jc.parsers.ifconfig._IfconfigParser.list_interfaces) + * [count\_interfaces](#jc.parsers.ifconfig._IfconfigParser.count_interfaces) + * [filter\_interfaces](#jc.parsers.ifconfig._IfconfigParser.filter_interfaces) + * [get\_interface](#jc.parsers.ifconfig._IfconfigParser.get_interface) + * [get\_interfaces](#jc.parsers.ifconfig._IfconfigParser.get_interfaces) + * [is\_available](#jc.parsers.ifconfig._IfconfigParser.is_available) + * [parser](#jc.parsers.ifconfig._IfconfigParser.parser) + * [parse](#jc.parsers.ifconfig.parse) + # jc.parsers.ifconfig diff --git a/docs/parsers/ini.md b/docs/parsers/ini.md index f5d7892d..21dfc0ae 100644 --- a/docs/parsers/ini.md +++ b/docs/parsers/ini.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ini](#jc.parsers.ini) + * [parse](#jc.parsers.ini.parse) + # jc.parsers.ini diff --git a/docs/parsers/iostat.md b/docs/parsers/iostat.md index e0843778..14f81bea 100644 --- a/docs/parsers/iostat.md +++ b/docs/parsers/iostat.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.iostat](#jc.parsers.iostat) + * [parse](#jc.parsers.iostat.parse) + # jc.parsers.iostat diff --git a/docs/parsers/iostat_s.md b/docs/parsers/iostat_s.md index fd116a85..1aa3e98d 100644 --- a/docs/parsers/iostat_s.md +++ b/docs/parsers/iostat_s.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.iostat\_s](#jc.parsers.iostat_s) + * [parse](#jc.parsers.iostat_s.parse) + # jc.parsers.iostat\_s diff --git a/docs/parsers/iptables.md b/docs/parsers/iptables.md index 3066c881..1ccc6fea 100644 --- a/docs/parsers/iptables.md +++ b/docs/parsers/iptables.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.iptables](#jc.parsers.iptables) + * [parse](#jc.parsers.iptables.parse) + # jc.parsers.iptables diff --git a/docs/parsers/iw_scan.md b/docs/parsers/iw_scan.md index df0ed6df..e123e54a 100644 --- a/docs/parsers/iw_scan.md +++ b/docs/parsers/iw_scan.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.iw\_scan](#jc.parsers.iw_scan) + * [parse](#jc.parsers.iw_scan.parse) + # jc.parsers.iw\_scan diff --git a/docs/parsers/jar_manifest.md b/docs/parsers/jar_manifest.md index 7e2b44d2..b0759241 100644 --- a/docs/parsers/jar_manifest.md +++ b/docs/parsers/jar_manifest.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.jar\_manifest](#jc.parsers.jar_manifest) + * [parse](#jc.parsers.jar_manifest.parse) + # jc.parsers.jar\_manifest diff --git a/docs/parsers/jobs.md b/docs/parsers/jobs.md index d24d7e2b..71403fe3 100644 --- a/docs/parsers/jobs.md +++ b/docs/parsers/jobs.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.jobs](#jc.parsers.jobs) + * [parse](#jc.parsers.jobs.parse) + # jc.parsers.jobs diff --git a/docs/parsers/kv.md b/docs/parsers/kv.md index 024e1a88..1c689fa0 100644 --- a/docs/parsers/kv.md +++ b/docs/parsers/kv.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.kv](#jc.parsers.kv) + * [parse](#jc.parsers.kv.parse) + # jc.parsers.kv diff --git a/docs/parsers/last.md b/docs/parsers/last.md index aa9de406..e5fd0791 100644 --- a/docs/parsers/last.md +++ b/docs/parsers/last.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.last](#jc.parsers.last) + * [parse](#jc.parsers.last.parse) + # jc.parsers.last diff --git a/docs/parsers/ls.md b/docs/parsers/ls.md index f9acc3df..6fdbb917 100644 --- a/docs/parsers/ls.md +++ b/docs/parsers/ls.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ls](#jc.parsers.ls) + * [parse](#jc.parsers.ls.parse) + # jc.parsers.ls diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index 1016aafa..f9fcc88c 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ls\_s](#jc.parsers.ls_s) + * [parse](#jc.parsers.ls_s.parse) + # jc.parsers.ls\_s diff --git a/docs/parsers/lsblk.md b/docs/parsers/lsblk.md index 137bb66b..ff40f835 100644 --- a/docs/parsers/lsblk.md +++ b/docs/parsers/lsblk.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.lsblk](#jc.parsers.lsblk) + * [parse](#jc.parsers.lsblk.parse) + # jc.parsers.lsblk diff --git a/docs/parsers/lsmod.md b/docs/parsers/lsmod.md index 918196c2..83c3920a 100644 --- a/docs/parsers/lsmod.md +++ b/docs/parsers/lsmod.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.lsmod](#jc.parsers.lsmod) + * [parse](#jc.parsers.lsmod.parse) + # jc.parsers.lsmod diff --git a/docs/parsers/lsof.md b/docs/parsers/lsof.md index 91d8b439..85f30786 100644 --- a/docs/parsers/lsof.md +++ b/docs/parsers/lsof.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.lsof](#jc.parsers.lsof) + * [parse](#jc.parsers.lsof.parse) + # jc.parsers.lsof diff --git a/docs/parsers/lsusb.md b/docs/parsers/lsusb.md index 4243593c..069902ee 100644 --- a/docs/parsers/lsusb.md +++ b/docs/parsers/lsusb.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.lsusb](#jc.parsers.lsusb) + * [parse](#jc.parsers.lsusb.parse) + # jc.parsers.lsusb diff --git a/docs/parsers/mount.md b/docs/parsers/mount.md index 4eb3ba20..aaff999e 100644 --- a/docs/parsers/mount.md +++ b/docs/parsers/mount.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.mount](#jc.parsers.mount) + * [parse](#jc.parsers.mount.parse) + # jc.parsers.mount diff --git a/docs/parsers/netstat.md b/docs/parsers/netstat.md index c48fbcfc..349b1a79 100644 --- a/docs/parsers/netstat.md +++ b/docs/parsers/netstat.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.netstat](#jc.parsers.netstat) + * [parse](#jc.parsers.netstat.parse) + # jc.parsers.netstat diff --git a/docs/parsers/ntpq.md b/docs/parsers/ntpq.md index 15ca65db..a89a487c 100644 --- a/docs/parsers/ntpq.md +++ b/docs/parsers/ntpq.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ntpq](#jc.parsers.ntpq) + * [parse](#jc.parsers.ntpq.parse) + # jc.parsers.ntpq diff --git a/docs/parsers/passwd.md b/docs/parsers/passwd.md index e0682d55..3fa49cf0 100644 --- a/docs/parsers/passwd.md +++ b/docs/parsers/passwd.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.passwd](#jc.parsers.passwd) + * [parse](#jc.parsers.passwd.parse) + # jc.parsers.passwd diff --git a/docs/parsers/ping.md b/docs/parsers/ping.md index 3ffce210..3783e635 100644 --- a/docs/parsers/ping.md +++ b/docs/parsers/ping.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ping](#jc.parsers.ping) + * [parse](#jc.parsers.ping.parse) + # jc.parsers.ping diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index f31a2c68..282fd73d 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ping\_s](#jc.parsers.ping_s) + * [parse](#jc.parsers.ping_s.parse) + # jc.parsers.ping\_s diff --git a/docs/parsers/pip_list.md b/docs/parsers/pip_list.md index de814615..ba283d33 100644 --- a/docs/parsers/pip_list.md +++ b/docs/parsers/pip_list.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.pip\_list](#jc.parsers.pip_list) + * [parse](#jc.parsers.pip_list.parse) + # jc.parsers.pip\_list diff --git a/docs/parsers/pip_show.md b/docs/parsers/pip_show.md index 9de9de46..77085772 100644 --- a/docs/parsers/pip_show.md +++ b/docs/parsers/pip_show.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.pip\_show](#jc.parsers.pip_show) + * [parse](#jc.parsers.pip_show.parse) + # jc.parsers.pip\_show diff --git a/docs/parsers/ps.md b/docs/parsers/ps.md index b2e21c5c..40216486 100644 --- a/docs/parsers/ps.md +++ b/docs/parsers/ps.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ps](#jc.parsers.ps) + * [parse](#jc.parsers.ps.parse) + # jc.parsers.ps diff --git a/docs/parsers/route.md b/docs/parsers/route.md index c44d9a2a..eceedd19 100644 --- a/docs/parsers/route.md +++ b/docs/parsers/route.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.route](#jc.parsers.route) + * [parse](#jc.parsers.route.parse) + # jc.parsers.route diff --git a/docs/parsers/rpm_qi.md b/docs/parsers/rpm_qi.md index d3c4f71e..19df2201 100644 --- a/docs/parsers/rpm_qi.md +++ b/docs/parsers/rpm_qi.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.rpm\_qi](#jc.parsers.rpm_qi) + * [parse](#jc.parsers.rpm_qi.parse) + # jc.parsers.rpm\_qi diff --git a/docs/parsers/sfdisk.md b/docs/parsers/sfdisk.md index eb0d8cde..d2e75ff4 100644 --- a/docs/parsers/sfdisk.md +++ b/docs/parsers/sfdisk.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.sfdisk](#jc.parsers.sfdisk) + * [parse](#jc.parsers.sfdisk.parse) + # jc.parsers.sfdisk diff --git a/docs/parsers/shadow.md b/docs/parsers/shadow.md index b184b650..6e47112e 100644 --- a/docs/parsers/shadow.md +++ b/docs/parsers/shadow.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.shadow](#jc.parsers.shadow) + * [parse](#jc.parsers.shadow.parse) + # jc.parsers.shadow diff --git a/docs/parsers/ss.md b/docs/parsers/ss.md index 17031b5e..f3a0ac2d 100644 --- a/docs/parsers/ss.md +++ b/docs/parsers/ss.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ss](#jc.parsers.ss) + * [parse](#jc.parsers.ss.parse) + # jc.parsers.ss diff --git a/docs/parsers/stat.md b/docs/parsers/stat.md index 72566c41..77297795 100644 --- a/docs/parsers/stat.md +++ b/docs/parsers/stat.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.stat](#jc.parsers.stat) + * [parse](#jc.parsers.stat.parse) + # jc.parsers.stat diff --git a/docs/parsers/stat_s.md b/docs/parsers/stat_s.md index 4f560f7c..5ba10d00 100644 --- a/docs/parsers/stat_s.md +++ b/docs/parsers/stat_s.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.stat\_s](#jc.parsers.stat_s) + * [parse](#jc.parsers.stat_s.parse) + # jc.parsers.stat\_s diff --git a/docs/parsers/sysctl.md b/docs/parsers/sysctl.md index 1b77027a..6fb58d17 100644 --- a/docs/parsers/sysctl.md +++ b/docs/parsers/sysctl.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.sysctl](#jc.parsers.sysctl) + * [parse](#jc.parsers.sysctl.parse) + # jc.parsers.sysctl diff --git a/docs/parsers/systemctl.md b/docs/parsers/systemctl.md index 2359a0f4..95e30a69 100644 --- a/docs/parsers/systemctl.md +++ b/docs/parsers/systemctl.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.systemctl](#jc.parsers.systemctl) + * [parse](#jc.parsers.systemctl.parse) + # jc.parsers.systemctl diff --git a/docs/parsers/systemctl_lj.md b/docs/parsers/systemctl_lj.md index 324375d0..1fc4cbfa 100644 --- a/docs/parsers/systemctl_lj.md +++ b/docs/parsers/systemctl_lj.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.systemctl\_lj](#jc.parsers.systemctl_lj) + * [parse](#jc.parsers.systemctl_lj.parse) + # jc.parsers.systemctl\_lj diff --git a/docs/parsers/systemctl_ls.md b/docs/parsers/systemctl_ls.md index caca4b71..90fcf98a 100644 --- a/docs/parsers/systemctl_ls.md +++ b/docs/parsers/systemctl_ls.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.systemctl\_ls](#jc.parsers.systemctl_ls) + * [parse](#jc.parsers.systemctl_ls.parse) + # jc.parsers.systemctl\_ls diff --git a/docs/parsers/systemctl_luf.md b/docs/parsers/systemctl_luf.md index 9624439e..51b42f05 100644 --- a/docs/parsers/systemctl_luf.md +++ b/docs/parsers/systemctl_luf.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.systemctl\_luf](#jc.parsers.systemctl_luf) + * [parse](#jc.parsers.systemctl_luf.parse) + # jc.parsers.systemctl\_luf diff --git a/docs/parsers/systeminfo.md b/docs/parsers/systeminfo.md index fa77289c..7662053f 100644 --- a/docs/parsers/systeminfo.md +++ b/docs/parsers/systeminfo.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.systeminfo](#jc.parsers.systeminfo) + * [parse](#jc.parsers.systeminfo.parse) + # jc.parsers.systeminfo diff --git a/docs/parsers/time.md b/docs/parsers/time.md index 6ade177f..2ec39fea 100644 --- a/docs/parsers/time.md +++ b/docs/parsers/time.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.time](#jc.parsers.time) + * [parse](#jc.parsers.time.parse) + # jc.parsers.time diff --git a/docs/parsers/timedatectl.md b/docs/parsers/timedatectl.md index 8c4b1539..03471201 100644 --- a/docs/parsers/timedatectl.md +++ b/docs/parsers/timedatectl.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.timedatectl](#jc.parsers.timedatectl) + * [parse](#jc.parsers.timedatectl.parse) + # jc.parsers.timedatectl diff --git a/docs/parsers/tracepath.md b/docs/parsers/tracepath.md index 19636189..11ee1d8b 100644 --- a/docs/parsers/tracepath.md +++ b/docs/parsers/tracepath.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.tracepath](#jc.parsers.tracepath) + * [parse](#jc.parsers.tracepath.parse) + # jc.parsers.tracepath diff --git a/docs/parsers/traceroute.md b/docs/parsers/traceroute.md index e1fbde83..38bbcb19 100644 --- a/docs/parsers/traceroute.md +++ b/docs/parsers/traceroute.md @@ -1,4 +1,12 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.traceroute](#jc.parsers.traceroute) + * [\_\_version\_\_](#jc.parsers.traceroute.__version__) + * [\_Hop](#jc.parsers.traceroute._Hop) + * [add\_probe](#jc.parsers.traceroute._Hop.add_probe) + * [parse](#jc.parsers.traceroute.parse) + # jc.parsers.traceroute diff --git a/docs/parsers/ufw.md b/docs/parsers/ufw.md index ddc29105..a3028cdf 100644 --- a/docs/parsers/ufw.md +++ b/docs/parsers/ufw.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ufw](#jc.parsers.ufw) + * [parse](#jc.parsers.ufw.parse) + # jc.parsers.ufw diff --git a/docs/parsers/ufw_appinfo.md b/docs/parsers/ufw_appinfo.md index 0ad1eecc..c57d168c 100644 --- a/docs/parsers/ufw_appinfo.md +++ b/docs/parsers/ufw_appinfo.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.ufw\_appinfo](#jc.parsers.ufw_appinfo) + * [parse](#jc.parsers.ufw_appinfo.parse) + # jc.parsers.ufw\_appinfo diff --git a/docs/parsers/uname.md b/docs/parsers/uname.md index 71e67ddc..e9da9a51 100644 --- a/docs/parsers/uname.md +++ b/docs/parsers/uname.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.uname](#jc.parsers.uname) + * [parse](#jc.parsers.uname.parse) + # jc.parsers.uname diff --git a/docs/parsers/universal.md b/docs/parsers/universal.md index 799603ef..a1c62688 100644 --- a/docs/parsers/universal.md +++ b/docs/parsers/universal.md @@ -1,3 +1,9 @@ +# Table of Contents + +* [jc.parsers.universal](#jc.parsers.universal) + * [simple\_table\_parse](#jc.parsers.universal.simple_table_parse) + * [sparse\_table\_parse](#jc.parsers.universal.sparse_table_parse) + # jc.parsers.universal diff --git a/docs/parsers/upower.md b/docs/parsers/upower.md index ffcbb334..38ee4575 100644 --- a/docs/parsers/upower.md +++ b/docs/parsers/upower.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.upower](#jc.parsers.upower) + * [parse](#jc.parsers.upower.parse) + # jc.parsers.upower diff --git a/docs/parsers/uptime.md b/docs/parsers/uptime.md index 9d5375bd..7b460a7c 100644 --- a/docs/parsers/uptime.md +++ b/docs/parsers/uptime.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.uptime](#jc.parsers.uptime) + * [parse](#jc.parsers.uptime.parse) + # jc.parsers.uptime diff --git a/docs/parsers/vmstat.md b/docs/parsers/vmstat.md index 2291fb79..2171bea5 100644 --- a/docs/parsers/vmstat.md +++ b/docs/parsers/vmstat.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.vmstat](#jc.parsers.vmstat) + * [parse](#jc.parsers.vmstat.parse) + # jc.parsers.vmstat diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index 6f85dce7..e011c107 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.vmstat\_s](#jc.parsers.vmstat_s) + * [parse](#jc.parsers.vmstat_s.parse) + # jc.parsers.vmstat\_s diff --git a/docs/parsers/w.md b/docs/parsers/w.md index 378fa467..92624a70 100644 --- a/docs/parsers/w.md +++ b/docs/parsers/w.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.w](#jc.parsers.w) + * [parse](#jc.parsers.w.parse) + # jc.parsers.w diff --git a/docs/parsers/wc.md b/docs/parsers/wc.md index 49f2f82b..5a575f9e 100644 --- a/docs/parsers/wc.md +++ b/docs/parsers/wc.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.wc](#jc.parsers.wc) + * [parse](#jc.parsers.wc.parse) + # jc.parsers.wc diff --git a/docs/parsers/who.md b/docs/parsers/who.md index b1d5996f..8444fd31 100644 --- a/docs/parsers/who.md +++ b/docs/parsers/who.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.who](#jc.parsers.who) + * [parse](#jc.parsers.who.parse) + # jc.parsers.who diff --git a/docs/parsers/xml.md b/docs/parsers/xml.md index 1dab4203..1bfb715d 100644 --- a/docs/parsers/xml.md +++ b/docs/parsers/xml.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.xml](#jc.parsers.xml) + * [parse](#jc.parsers.xml.parse) + # jc.parsers.xml diff --git a/docs/parsers/yaml.md b/docs/parsers/yaml.md index 6e4d8cd2..96908eb2 100644 --- a/docs/parsers/yaml.md +++ b/docs/parsers/yaml.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.yaml](#jc.parsers.yaml) + * [parse](#jc.parsers.yaml.parse) + # jc.parsers.yaml diff --git a/docs/parsers/zipinfo.md b/docs/parsers/zipinfo.md index 49a4712a..06fc5f85 100644 --- a/docs/parsers/zipinfo.md +++ b/docs/parsers/zipinfo.md @@ -1,4 +1,9 @@ [Home](https://kellyjonbrazil.github.io/jc/) +# Table of Contents + +* [jc.parsers.zipinfo](#jc.parsers.zipinfo) + * [parse](#jc.parsers.zipinfo.parse) + # jc.parsers.zipinfo diff --git a/docs/readme.md b/docs/readme.md index aab68671..d1969fc3 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,3 +1,7 @@ +# Table of Contents + +* [jc](#jc) + # jc diff --git a/docs/utils.md b/docs/utils.md index deed2f71..ac60439a 100644 --- a/docs/utils.md +++ b/docs/utils.md @@ -1,3 +1,20 @@ +# Table of Contents + +* [jc.utils](#jc.utils) + * [warning\_message](#jc.utils.warning_message) + * [error\_message](#jc.utils.error_message) + * [compatibility](#jc.utils.compatibility) + * [has\_data](#jc.utils.has_data) + * [convert\_to\_int](#jc.utils.convert_to_int) + * [convert\_to\_float](#jc.utils.convert_to_float) + * [convert\_to\_bool](#jc.utils.convert_to_bool) + * [stream\_success](#jc.utils.stream_success) + * [stream\_error](#jc.utils.stream_error) + * [input\_type\_check](#jc.utils.input_type_check) + * [streaming\_input\_type\_check](#jc.utils.streaming_input_type_check) + * [streaming\_line\_input\_type\_check](#jc.utils.streaming_line_input_type_check) + * [timestamp](#jc.utils.timestamp) + # jc.utils diff --git a/jc/lib.py b/jc/lib.py index 1d7babd9..a87f0b90 100644 --- a/jc/lib.py +++ b/jc/lib.py @@ -140,15 +140,15 @@ def _get_parser(parser_mod_name): modpath = 'jcparsers.' if parser_cli_name in local_parsers else 'jc.parsers.' return importlib.import_module(f'{modpath}{parser_mod_name}') -def parse(parser_mod_name: str, - data: Union[str, Iterable[str]], - quiet: Optional[bool] = False, - raw: Optional[bool] = False, - ignore_exceptions: Optional[Union[None, bool]] = None, - **kwargs: Any, - ) -> Union[Dict[str, Any], - List[Dict[str, Any]], - Iterator[Dict[str, Any]]]: + +def parse( + parser_mod_name: str, + data: Union[str, Iterable[str]], + quiet: Optional[bool] = False, + raw: Optional[bool] = False, + ignore_exceptions: Optional[Union[None, bool]] = None, + **kwargs: Any, +) -> Union[Dict[str, Any], List[Dict[str, Any]], Iterator[Dict[str, Any]]]: """ Parse the string data using the supplied parser module.