X-Git-Url: https://code.grnet.gr/git/kamaki/blobdiff_plain/e9304ec6da60a79b1acc8092db03253819807a69..c3857b7daa2fc3f62b90abf0187ceb990b6bcb76:/docs/conf.py diff --git a/docs/conf.py b/docs/conf.py index 33c8490..2dc22d5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,10 +3,11 @@ # Kamaki documentation build configuration file, created by # sphinx-quickstart on Tue Nov 29 15:15:50 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. +# auto-generated file. # # All configuration values have a default; values that are commented out # serve to show the default. @@ -15,17 +16,25 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -import sys, os -#sys.path.append('/home/saxtouri/src/synnefo/snf-common/') -sys.path.append('../') +from sys import path, stderr +import os -# -- General configuration ----------------------------------------------------- +try: + from objpool import http + http +except ImportError: + stderr.write("`objpool` package is required to build kamaki docs.\n") + #exit() + +path.insert(0, os.path.join(os.path.abspath(os.path.dirname(__file__)), '..')) + +# -- General configuration --------------------------------------------------- # 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.viewcode'] # Add any paths that contain templates here, relative to this directory. @@ -42,7 +51,7 @@ master_doc = 'index' # General information about the project. project = u'Kamaki' -copyright = u'2012, GRNet' +copyright = u'2012, GRNET' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -51,7 +60,7 @@ copyright = u'2012, GRNet' # The short X.Y version. version = '0.6' # The full version, including alpha/beta/rc tags. -release = '0.6.1' +release = '0.6.3' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -67,7 +76,8 @@ release = '0.6.1' # directories to ignore when looking for source files. exclude_patterns = ['_build'] -# 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. @@ -88,7 +98,7 @@ pygments_style = 'sphinx' #modindex_common_prefix = [] -# -- Options for HTML output --------------------------------------------------- +# -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. @@ -168,7 +178,7 @@ html_static_path = ['_static'] htmlhelp_basename = 'Kamakidoc' -# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output ------------------------------------------------ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). @@ -182,10 +192,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', 'Kamaki.tex', u'Kamaki Documentation', - u'GRNet', 'manual'), + u'GRNET', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -209,7 +220,7 @@ latex_documents = [ #latex_domain_indices = True -# -- Options for manual page output -------------------------------------------- +# -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). @@ -221,14 +232,14 @@ man_pages = [ #man_show_urls = False -# -- Options for Texinfo output ------------------------------------------------ +# -- Options for Texinfo output ---------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'Kamaki', u'Kamaki Documentation', - u'GRNet', 'Kamaki', 'One line description of project.', + u'GRNET', 'Kamaki', 'One line description of project.', 'Miscellaneous'), ]