2009-03-06 00:31:20 +01:00
|
|
|
"Build up the sphinx autodoc file for the python code"
|
|
|
|
|
|
|
|
|
|
import os
|
2010-12-19 06:13:46 +01:00
|
|
|
import sys
|
2009-03-06 00:31:20 +01:00
|
|
|
|
2010-12-19 06:14:20 +01:00
|
|
|
docs_folder = os.path.dirname(__file__)
|
|
|
|
|
pywin_folder = os.path.dirname(docs_folder)
|
2009-03-06 00:31:20 +01:00
|
|
|
|
|
|
|
|
sys.path.append(pywin_folder)
|
|
|
|
|
pywin_folder = os.path.join(pywin_folder, "pywinauto")
|
|
|
|
|
|
|
|
|
|
excluded_dirs = ["unittests"]
|
|
|
|
|
excluded_files = [
|
|
|
|
|
"_menux.py",
|
|
|
|
|
"__init__.py",
|
|
|
|
|
"win32defines.py",
|
|
|
|
|
"win32structures.py",
|
|
|
|
|
"win32functions.py"]
|
|
|
|
|
|
|
|
|
|
output_folder = "code"
|
|
|
|
|
|
|
|
|
|
try:
|
|
|
|
|
os.mkdir(output_folder)
|
|
|
|
|
except WindowsError:
|
|
|
|
|
pass
|
|
|
|
|
|
|
|
|
|
module_docs = []
|
|
|
|
|
for root, dirs, files in os.walk(pywin_folder):
|
|
|
|
|
|
|
|
|
|
# Skip over directories we don't want to document
|
|
|
|
|
for i, d in enumerate(dirs):
|
|
|
|
|
if d in excluded_dirs:
|
|
|
|
|
del dirs[i]
|
|
|
|
|
|
|
|
|
|
py_files = [f for f in files if f.endswith(".py")]
|
|
|
|
|
|
|
|
|
|
# skip over py files we don't want to document
|
|
|
|
|
for filename in py_files:
|
|
|
|
|
if filename in excluded_files:
|
|
|
|
|
continue
|
|
|
|
|
|
|
|
|
|
doc_source_filename = os.path.join(
|
|
|
|
|
output_folder, filename + ".txt")
|
|
|
|
|
if os.path.exists(doc_source_filename):
|
|
|
|
|
continue
|
|
|
|
|
|
|
|
|
|
print filename
|
|
|
|
|
|
|
|
|
|
filepath = os.path.join(root, filename)
|
|
|
|
|
|
|
|
|
|
modulename = filepath.split("\\")
|
|
|
|
|
modulename = modulename[modulename.index('pywinauto'):]
|
|
|
|
|
|
|
|
|
|
# remove extension
|
|
|
|
|
modulename[-1] = modulename[-1][:-3]
|
|
|
|
|
|
|
|
|
|
modulename = ".".join(modulename)
|
|
|
|
|
|
|
|
|
|
out = open(doc_source_filename, "w")
|
|
|
|
|
|
|
|
|
|
out.write(modulename + "\n")
|
|
|
|
|
out.write("-" * len(modulename) + "\n")
|
|
|
|
|
out.write(" .. automodule:: %s\n"% modulename)
|
|
|
|
|
out.write(" :members:\n")
|
|
|
|
|
out.write(" :undoc-members:\n\n")
|
|
|
|
|
#out.write(" :inherited-members:\n")
|
|
|
|
|
#out.write(" .. autoattribute:: %s\n"% modulename)
|
|
|
|
|
out.close()
|
|
|
|
|
|
|
|
|
|
module_docs.append(doc_source_filename)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# This section needs to be updated - I should idealy parse the
|
|
|
|
|
# existing file to see if any new docs have been added, if not then
|
|
|
|
|
# I should just leave the file alone rathre than re-create.
|
|
|
|
|
#
|
|
|
|
|
#c = open(os.path.join(output_folder, "code.txt"), "w")
|
|
|
|
|
#c.write("Source Code\n")
|
|
|
|
|
#c.write("=" * 30 + "\n")
|
|
|
|
|
#
|
|
|
|
|
#c.write(".. toctree::\n")
|
|
|
|
|
#c.write(" :maxdepth: 3\n\n")
|
|
|
|
|
#for doc in module_docs:
|
|
|
|
|
# c.write(" " + doc + "\n")
|
|
|
|
|
#
|
|
|
|
|
#c.close()
|
|
|
|
|
#
|
