'+s.intro_text+'
'; + var outro = ''+s.outro_text+'
'; + var loading = $(''+s.loading_text+'
'); + + if(typeof(s.username) == "string"){ + s.username = [s.username]; + } + + if (s.loading_text) $(this).append(loading); + $.getJSON(build_url(), function(data){ + if (s.loading_text) loading.remove(); + if (s.intro_text) list.before(intro); + $.each((data.results || data), function(i,item){ + // auto join text based on verb tense and content + if (s.join_text == "auto") { + if (item.text.match(/^(@([A-Za-z0-9-_]+)) .*/i)) { + var join_text = s.auto_join_text_reply; + } else if (item.text.match(/(^\w+:\/\/[A-Za-z0-9-_]+\.[A-Za-z0-9-_:%&\?\/.=]+) .*/i)) { + var join_text = s.auto_join_text_url; + } else if (item.text.match(/^((\w+ed)|just) .*/im)) { + var join_text = s.auto_join_text_ed; + } else if (item.text.match(/^(\w*ing) .*/i)) { + var join_text = s.auto_join_text_ing; + } else { + var join_text = s.auto_join_text_default; + } + } else { + var join_text = s.join_text; + }; + + var from_user = item.from_user || item.user.screen_name; + var profile_image_url = item.profile_image_url || item.user.profile_image_url; + var join_template = ' '+join_text+' '; + var join = ((s.join_text) ? join_template : ' '); + var avatar_template = '
+
+ {%- endif %}{% endif %}
+{%- endmacro %}
+
+{% block relbar1 %}{% endblock relbar1 %}
+
+{% block header %}
+
+ {%- block sidebarlogo %}
+ {%- if logo %}
+
+ {%- endif %}
+ {%- endblock %}
+ {%- block sidebartoc %}
+ {%- if display_toc %}
+
+ {{ _('Table Of Contents') }}
+ {{ toc }} + {%- endif %} + {%- endblock %} + {%- block sidebarrel %} + {%- if prev %} +{{ _('Previous topic') }}
+ + {%- endif %} + {%- if next %} +{{ _('Next topic') }}
+ + {%- endif %} + {%- endblock %} + {%- block sidebarsourcelink %} + {%- if show_source and has_source and sourcename %} +{{ _('This Page') }}
+ + {%- endif %} + {%- endblock %} + {%- if customsidebar %} + {% include customsidebar %} + {%- endif %} + {%- block sidebarsearch %} + {%- if pagename != "search" %} + + + {%- endif %} + {%- endblock %} +
+
+{% endblock %}
\ No newline at end of file
diff --git a/doc/source/_theme/theme.conf b/doc/source/_theme/theme.conf
new file mode 100644
index 00000000..1cc40044
--- /dev/null
+++ b/doc/source/_theme/theme.conf
@@ -0,0 +1,4 @@
+[theme]
+inherit = basic
+stylesheet = nature.css
+pygments_style = tango
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 4898cd1a..33609caf 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -1,10 +1,10 @@
# -*- coding: utf-8 -*-
#
# Ceilometer documentation build configuration file, created by
-# sphinx-quickstart on Wed Jun 27 11:36:22 2012.
+# sphinx-quickstart on Thu Oct 27 11:38:59 2011.
#
-# This file is execfile()d with the current directory set to its containing
-# dir.
+# This file is execfile()d with the current directory set to its
+# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
@@ -12,9 +12,119 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import os
-import subprocess
import sys
+import os
+
+BASE_DIR = os.path.dirname(os.path.abspath(__file__))
+ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
+
+sys.path.insert(0, ROOT)
+
+# This is required for ReadTheDocs.org, but isn't a bad idea anyway.
+os.environ['DJANGO_SETTINGS_MODULE'] = 'openstack_dashboard.settings'
+
+import ceilometer.version
+
+
+def write_autodoc_index():
+
+ 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))
+ print "SEARCHING %s" % sourcedir
+ for root, dirs, files in os.walk("."):
+ for filename in files:
+ if filename.endswith(".py"):
+ # remove the pieces of the root
+ 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)
+ #print result
+ modlist.append(result)
+ return modlist
+
+ RSTDIR = os.path.abspath(os.path.join(BASE_DIR, "sourcecode"))
+ SRCS = {'ceilometer': ROOT}
+
+ EXCLUDED_MODULES = ('ceilometer.tests')
+ CURRENT_SOURCES = {}
+
+ if not(os.path.exists(RSTDIR)):
+ os.mkdir(RSTDIR)
+ CURRENT_SOURCES[RSTDIR] = ['autoindex.rst']
+
+ INDEXOUT = open(os.path.join(RSTDIR, "autoindex.rst"), "w")
+ INDEXOUT.write("=================\n")
+ INDEXOUT.write("Source Code Index\n")
+ INDEXOUT.write("=================\n")
+
+ for modulename, path in SRCS.items():
+ sys.stdout.write("Generating source documentation for %s\n" %
+ modulename)
+ INDEXOUT.write("\n%s\n" % modulename.capitalize())
+ INDEXOUT.write("%s\n" % ("=" * len(modulename),))
+ INDEXOUT.write(".. toctree::\n")
+ INDEXOUT.write(" :maxdepth: 1\n")
+ INDEXOUT.write("\n")
+
+ MOD_DIR = os.path.join(RSTDIR, modulename)
+ CURRENT_SOURCES[MOD_DIR] = []
+ if not(os.path.exists(MOD_DIR)):
+ os.mkdir(MOD_DIR)
+ for module in find_autodoc_modules(modulename, path):
+ if any([module.startswith(exclude) for exclude \
+ in EXCLUDED_MODULES]):
+ print "Excluded module %s." % module
+ continue
+ mod_path = os.path.join(path, *module.split("."))
+ generated_file = os.path.join(MOD_DIR, "%s.rst" % module)
+
+ INDEXOUT.write(" %s/%s\n" % (modulename, module))
+
+ # Find the __init__.py module if this is a directory
+ if os.path.isdir(mod_path):
+ source_file = ".".join((os.path.join(mod_path, "__init__"),
+ "py",))
+ else:
+ source_file = ".".join((os.path.join(mod_path), "py"))
+
+ CURRENT_SOURCES[MOD_DIR].append("%s.rst" % module)
+ # Only generate a new file if the source has changed or we don't
+ # have a doc file to begin with.
+ if not os.access(generated_file, os.F_OK) or \
+ os.stat(generated_file).st_mtime < \
+ os.stat(source_file).st_mtime:
+ print "Module %s updated, generating new documentation." \
+ % module
+ FILEOUT = open(generated_file, "w")
+ header = "The :mod:`%s` Module" % module
+ FILEOUT.write("%s\n" % ("=" * len(header),))
+ FILEOUT.write("%s\n" % header)
+ FILEOUT.write("%s\n" % ("=" * len(header),))
+ FILEOUT.write(".. automodule:: %s\n" % module)
+ FILEOUT.write(" :members:\n")
+ FILEOUT.write(" :undoc-members:\n")
+ FILEOUT.write(" :show-inheritance:\n")
+ FILEOUT.write(" :noindex:\n")
+ FILEOUT.close()
+
+ INDEXOUT.close()
+
+ # Delete auto-generated .rst files for sources which no longer exist
+ for directory, subdirs, files in list(os.walk(RSTDIR)):
+ for old_file in files:
+ if old_file not in CURRENT_SOURCES.get(directory, []):
+ print "Removing outdated file for %s" % old_file
+ os.remove(os.path.join(directory, old_file))
+
+
+write_autodoc_index()
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -26,20 +136,27 @@ import sys
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+# Add any Sphinx extension module names here, as strings.
+# They can be extensions coming with Sphinx (named 'sphinx.ext.*')
+# or your custom ones.
extensions = ['sphinx.ext.autodoc',
+ 'sphinx.ext.intersphinx',
'sphinx.ext.todo',
- 'sphinxcontrib.autohttp.flask',
- 'wsme.sphinxext',
- ]
+ 'sphinxcontrib.autohttp.flask',
+ 'wsme.sphinxext',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.pngmath',
+ 'sphinx.ext.viewcode']
wsme_protocols = ['restjson', 'restxml']
todo_include_todos = True
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+if os.getenv('HUDSON_PUBLISH_DOCS'):
+ templates_path = ['_ga', '_templates']
+else:
+ templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@@ -52,7 +169,7 @@ master_doc = 'index'
# General information about the project.
project = u'Ceilometer'
-copyright = u'2012, OpenStack, LLC'
+copyright = u'2013, OpenStack, LLC'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -76,10 +193,10 @@ version = ceilometer_version.canonical_version_string()
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
-exclude_patterns = []
+exclude_patterns = ['**/#*', '**~', '**/#*#']
-# The reST default role (used for this markup: `text`) to use for all documents
-# .
+# The reST default role (used for this markup: `text`)
+# to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
@@ -91,7 +208,7 @@ exclude_patterns = []
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
-#show_authors = False
+show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
@@ -99,17 +216,23 @@ pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
+primary_domain = 'py'
+nitpicky = False
+
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'default'
+html_theme_path = ['.']
+html_theme = '_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
+html_theme_options = {
+ "nosidebar": "false"
+}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
@@ -138,6 +261,8 @@ html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
+git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
+html_last_updated_fmt = os.popen(git_cmd).read()
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
@@ -194,11 +319,11 @@ latex_elements = {
}
# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual])
-# .
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
latex_documents = [
('index', 'Ceilometer.tex', u'Ceilometer Documentation',
- u'OpenStack, LLC', 'manual'),
+ u'OpenStack, LLC', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -228,7 +353,7 @@ latex_documents = [
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'ceilometer', u'Ceilometer Documentation',
- [u'OpenStack, LLC'], 1)
+ [u'OpenStack'], 1)
]
# If true, show URL addresses after external links.
@@ -241,9 +366,8 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- ('index', 'Ceilometer', u'Ceilometer Documentation',
- u'OpenStack, LLC', 'Ceilometer', 'One line description of project.',
- 'Miscellaneous'),
+ ('index', 'Ceilometer', u'Ceilometer Documentation', u'OpenStack',
+ 'Ceilometer', 'One line description of project.', 'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
@@ -254,3 +378,46 @@ texinfo_documents = [
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
+
+
+# -- Options for Epub output --------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'Ceilometer'
+epub_author = u'OpenStack'
+epub_publisher = u'OpenStack'
+epub_copyright = u'2012, OpenStack'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be an ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True