diff --git a/tools/extract_doc.py b/tools/extract_doc.py new file mode 100755 index 0000000..0f5fbc3 --- /dev/null +++ b/tools/extract_doc.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python + +import sys + +filename = sys.argv[1] + +if filename.endswith('__init__.py'): + sys.exit(0) + +package_name = filename.replace('/', '.').replace('.py', '') +sys.stdout.write('**%s**' % (package_name)) +sys.stdout.write('\n\n') +# sys.stdout.write('-' * len(package_name)) +# sys.stdout.write('\n\n') + +sys.stderr.write('\tExtract doc from %s\n' % (filename)) + +with open(filename) as infile: + copy = False + for line in infile: + if line.strip() in ['"""', "'''"]: + if not copy: + copy = True + else: + break + elif copy: + sys.stdout.write(line) + +sys.stdout.write('\n\n') diff --git a/tools/extract_docs.sh b/tools/extract_docs.sh new file mode 100755 index 0000000..e556330 --- /dev/null +++ b/tools/extract_docs.sh @@ -0,0 +1,16 @@ +#!/bin/sh + +MODULES_TARGET="docs/modules.md" +MAIN_MD="docs/main.md" +TARGET_MD="docs/index.md" + +rm -f "${MODULES_TARGET}" + +echo "Generate doc from iwla.py" +python tools/extract_doc.py iwla.py > "${MODULES_TARGET}" + +echo "Generate plugins documentation" +find plugins -name '*.py' -exec python tools/extract_doc.py \{\} \; >> "${MODULES_TARGET}" + +echo "Generate ${TARGET_MD}" +cat "${MAIN_MD}" "${MODULES_TARGET}" > "${TARGET_MD}"