Add tools to automatically extract documentation
This commit is contained in:
29
tools/extract_doc.py
Executable file
29
tools/extract_doc.py
Executable file
@@ -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')
|
||||
Reference in New Issue
Block a user