X-Git-Url: https://code.grnet.gr/git/snf-image-creator/blobdiff_plain/fba0968870e13efbe1926fa43363aa56efd79ee4..d8a12a7ee6817c93a400af602ebf1366c1309cbb:/docs/conf.py diff --git a/docs/conf.py b/docs/conf.py index c39fb2e..c72f4e9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,7 +3,8 @@ # snf-image-creator documentation build configuration file, created by # sphinx-quickstart on Mon Oct 8 12:34:17 2012. # -# 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. @@ -11,20 +12,21 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os +import sys +import os # 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 # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) -# -- General configuration ----------------------------------------------------- +# -- 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 = [] # Add any paths that contain templates here, relative to this directory. @@ -41,16 +43,16 @@ master_doc = 'index' # General information about the project. project = u'snf-image-creator' -copyright = u'2012, GRNET' +copyright = u'2012, 2013 GRNET S.A. All rights reserved' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.2.2' +version = '0.2.10' # The full version, including alpha/beta/rc tags. -release = '0.2.2' +release = '0.2.10' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -66,7 +68,8 @@ release = '0.2.2' # 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. @@ -87,7 +90,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. @@ -96,7 +99,27 @@ html_theme = 'default' # 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 = { + 'collapsiblesidebar': 'true', + 'footerbgcolor': '#55b577', + 'footertextcolor': '#000000', + 'sidebarbgcolor': '#ffffff', + 'sidebarbtncolor': '#f2f2f2', + 'sidebartextcolor': '#000000', + 'sidebarlinkcolor': '#328e4a', + 'relbarbgcolor': '#55b577', + 'relbartextcolor': '#ffffff', + 'relbarlinkcolor': '#ffffff', + 'bgcolor': '#ffffff', + 'textcolor': '#000000', + 'headbgcolor': '#ffffff', + 'headtextcolor': '#000000', + 'headlinkcolor': '#c60f0f', + 'linkcolor': '#328e4a', + 'visitedlinkcolor': '#63409b', + 'codebgcolor': '#eeffcc', + 'codetextcolor': '#333333' +} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] @@ -167,7 +190,7 @@ html_static_path = ['_static'] htmlhelp_basename = 'snf-image-creatordoc' -# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output ------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). @@ -181,7 +204,8 @@ 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', 'snf-image-creator.tex', u'snf-image-creator Documentation', u'GRNET', 'manual'), @@ -208,20 +232,24 @@ 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). man_pages = [ - ('index', 'snf-image-creator', u'snf-image-creator Documentation', - [u'GRNET'], 1) + ('man/snf-image-creator', 'snf-image-creator', + 'Command line image creator for Synnefo', + 'Synnefo development team ', 1), + ('man/snf-mkimage', 'snf-mkimage', + 'Dialog-based image creator for Synnefo', + 'Synnefo development team ', 1) ] # If true, show URL addresses after external links. #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,