58 lines
1.8 KiB
Python
Executable File
58 lines
1.8 KiB
Python
Executable File
#!/usr/bin/env python
|
|
"""Generates files for sphinx documentation using a simple Autodoc based
|
|
template.
|
|
To use:
|
|
cd keystone/doc
|
|
./generate_autodoc_index.py
|
|
"""
|
|
|
|
import os
|
|
|
|
RSTDIR="source/sourcecode"
|
|
SOURCE="../keystone"
|
|
|
|
def find_autodoc_modules():
|
|
"""returns a list of modules in the SOURCE directory"""
|
|
modlist = []
|
|
for root, dirs, files in os.walk(SOURCE):
|
|
for filename in files:
|
|
if filename.endswith(".py"):
|
|
# root = ../keystone/test/unit
|
|
# filename = base.py
|
|
# remove the first two pieces of the root
|
|
elements = root.split(os.path.sep)[1:]
|
|
# and get the base module name
|
|
base, extension = os.path.splitext(filename)
|
|
if not (base == "__init__"):
|
|
elements.append(base)
|
|
modlist.append(".".join(elements))
|
|
return modlist
|
|
|
|
if not(os.path.exists(RSTDIR)):
|
|
os.mkdir(RSTDIR)
|
|
|
|
INDEXOUT = open("%s/autoindex.rst" % RSTDIR, "w")
|
|
INDEXOUT.write("Source Code Index\n")
|
|
INDEXOUT.write("=================\n")
|
|
INDEXOUT.write(".. toctree::\n")
|
|
INDEXOUT.write(" :maxdepth: 1\n")
|
|
INDEXOUT.write("\n")
|
|
|
|
for module in find_autodoc_modules():
|
|
generated_file = "%s/%s.rst" % (RSTDIR, module)
|
|
print "Generating %s" % generated_file
|
|
|
|
INDEXOUT.write(" %s\n" % module)
|
|
FILEOUT = open(generated_file, "w")
|
|
FILEOUT.write("The :mod:`%s` Module\n" % module)
|
|
FILEOUT.write("=============================="
|
|
"=============================="
|
|
"==============================\n")
|
|
FILEOUT.write(".. automodule:: %s\n" % module)
|
|
FILEOUT.write(" :members:\n")
|
|
FILEOUT.write(" :undoc-members:\n")
|
|
FILEOUT.write(" :show-inheritance:\n")
|
|
FILEOUT.close()
|
|
|
|
INDEXOUT.close()
|