From d8ddc074f026a2b7c72cdb2107ed8ff790a4bb5f Mon Sep 17 00:00:00 2001 From: termie Date: Thu, 19 Jan 2012 20:36:06 -0800 Subject: [PATCH] get docs working --- docs/Makefile | 2 +- docs/generate_autodoc_index.py | 76 ---------------------------------- keystone/catalog/core.py | 3 -- keystone/contrib/ec2/core.py | 3 -- keystone/identity/core.py | 3 -- keystone/policy/core.py | 3 -- keystone/token/core.py | 3 -- 7 files changed, 1 insertion(+), 92 deletions(-) delete mode 100755 docs/generate_autodoc_index.py diff --git a/docs/Makefile b/docs/Makefile index 03e3ef3bc3..79861705e5 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -47,7 +47,7 @@ clean: autodoc: $(SPHINXAPIDOC) -f -o $(SOURCEDIR) ../keystone -html: +html: autodoc $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/docs/generate_autodoc_index.py b/docs/generate_autodoc_index.py deleted file mode 100755 index 993369b028..0000000000 --- a/docs/generate_autodoc_index.py +++ /dev/null @@ -1,76 +0,0 @@ -#!/usr/bin/env python -"""Generates files for sphinx documentation using a simple Autodoc based -template. - -To use, just run as a script: - $ python doc/generate_autodoc_index.py -""" - -import os - - -base_dir = os.path.dirname(os.path.abspath(__file__)) -RSTDIR=os.path.join(base_dir, "source", "sourcecode") -SOURCEDIR=os.path.join(base_dir, "..") - -# Exclude these modules from the autodoc results -EXCLUDE_MODULES = ['keystone.backends.sqlalchemy.migrate_repo'] - -def in_exclude_list(module_name): - """Compares a module to the list of excluded modules - - Returns true if the provided module resides in or matches - an excluded module, false otherwise. - """ - for excluded_module in EXCLUDE_MODULES: - if module_name.startswith(excluded_module): - return True - return False - -def find_autodoc_modules(module_name, sourcedir): - """returns a list of modules in the SOURCE directory""" - modlist = [] - os.chdir(os.path.join(sourcedir, module_name)) - for root, dirs, files in os.walk("."): - for filename in files: - if filename.endswith(".py"): - # root = ./keystone/test/unit - # filename = base.py - elements = root.split(os.path.sep) - # replace the leading "." with the module name - elements[0] = module_name - # and get the base module name - base, extension = os.path.splitext(filename) - if not (base == "__init__"): - elements.append(base) - result = (".".join(elements)) - if not in_exclude_list(result): - modlist.append(result) - 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('keystone', SOURCEDIR): - generated_file = "%s/%s.rst" % (RSTDIR, module) - - 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() diff --git a/keystone/catalog/core.py b/keystone/catalog/core.py index a99c20571e..aecae36adf 100644 --- a/keystone/catalog/core.py +++ b/keystone/catalog/core.py @@ -20,9 +20,6 @@ class Manager(manager.Manager): See :mod:`keystone.manager.Manager` for more details on how this dynamically calls the backend. - See :mod:`keystone.backends.base.Catalog` for more details on the - interface provided by backends. - """ def __init__(self): diff --git a/keystone/contrib/ec2/core.py b/keystone/contrib/ec2/core.py index 1332b6431c..36a78f0898 100644 --- a/keystone/contrib/ec2/core.py +++ b/keystone/contrib/ec2/core.py @@ -22,9 +22,6 @@ class Manager(manager.Manager): See :mod:`keystone.manager.Manager` for more details on how this dynamically calls the backend. - See :mod:`keystone.backends.base.Ec2` for more details on the - interface provided by backends. - """ def __init__(self): diff --git a/keystone/identity/core.py b/keystone/identity/core.py index 9452b909ad..bc2f7916e1 100644 --- a/keystone/identity/core.py +++ b/keystone/identity/core.py @@ -25,9 +25,6 @@ class Manager(manager.Manager): See :mod:`keystone.manager.Manager` for more details on how this dynamically calls the backend. - See :mod:`keystone.backends.base.Identity` for more details on the - interface provided by backends. - """ def __init__(self): diff --git a/keystone/policy/core.py b/keystone/policy/core.py index 87ad743cd6..d5af09fe08 100644 --- a/keystone/policy/core.py +++ b/keystone/policy/core.py @@ -15,9 +15,6 @@ class Manager(manager.Manager): See :mod:`keystone.manager.Manager` for more details on how this dynamically calls the backend. - See :mod:`keystone.backends.base.Policy` for more details on the - interface provided by backends. - """ def __init__(self): diff --git a/keystone/token/core.py b/keystone/token/core.py index c48ca0be05..b0385f5a60 100644 --- a/keystone/token/core.py +++ b/keystone/token/core.py @@ -15,9 +15,6 @@ class Manager(manager.Manager): See :mod:`keystone.manager.Manager` for more details on how this dynamically calls the backend. - See :mod:`keystone.backends.base.Token` for more details on the - interface provided by backends. - """ def __init__(self):