1 # -*- coding: utf-8 -*-

     2 #

     3 # Publidoc documentation build configuration file, created by

     4 # sphinx-quickstart on Mon Jun  6 08:40:53 2011.

     5 #

     6 # This file is execfile()d with the current directory set to its containing dir.

     7 #

     8 # Note that not all possible configuration values are present in this

     9 # autogenerated file.

    10 #

    11 # All configuration values have a default; values that are commented out

    12 # serve to show the default.

    13 

    14 import sys, os

    15 

    16 # If extensions (or modules to document with autodoc) are in another directory,

    17 # add these directories to sys.path here. If the directory is relative to the

    18 # documentation root, use os.path.abspath to make it absolute, like shown here.

    19 #sys.path.insert(0, os.path.abspath('.'))

    20 

    21 # -- General configuration -----------------------------------------------------

    22 

    23 # If your documentation needs a minimal Sphinx version, state it here.

    24 #needs_sphinx = '1.0'

    25 

    26 # Add any Sphinx extension module names here, as strings. They can be extensions

    27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

    28 #extensions = ['sphinx.ext.pngmath']

    29 

    30 # Add any paths that contain templates here, relative to this directory.

    31 #templates_path = ['_templates']

    32 

    33 # The suffix of source filenames.

    34 source_suffix = '.rst'

    35 

    36 # The encoding of source files.

    37 #source_encoding = 'utf-8-sig'

    38 

    39 # The master toctree document.

    40 master_doc = 'index'

    41 

    42 # General information about the project.

    43 project = u'Publidoc'

    44 copyright = u'2011, Prismallia'

    45 

    46 # The version info for the project you're documenting, acts as replacement for

    47 # |version| and |release|, also used in various other places throughout the

    48 # built documents.

    49 #

    50 # The short X.Y version.

    51 version = '1.0'

    52 # The full version, including alpha/beta/rc tags.

    53 release = '1.0'

    54 

    55 # The language for content autogenerated by Sphinx. Refer to documentation

    56 # for a list of supported languages.

    57 #language = None

    58 language = 'fr'

    59 

    60 # There are two options for replacing |today|: either, you set today to some

    61 # non-false value, then it is used:

    62 #today = ''

    63 # Else, today_fmt is used as the format for a strftime call.

    64 #today_fmt = '%B %d, %Y'

    65 

    66 # List of patterns, relative to source directory, that match files and

    67 # directories to ignore when looking for source files.

    68 exclude_patterns = []

    69 

    70 # The reST default role (used for this markup: `text`) to use for all documents.

    71 #default_role = None

    72 

    73 # If true, '()' will be appended to :func: etc. cross-reference text.

    74 #add_function_parentheses = True

    75 

    76 # If true, the current module name will be prepended to all description

    77 # unit titles (such as .. function::).

    78 #add_module_names = True

    79 

    80 # If true, sectionauthor and moduleauthor directives will be shown in the

    81 # output. They are ignored by default.

    82 #show_authors = False

    83 

    84 # The name of the Pygments (syntax highlighting) style to use.

    85 pygments_style = 'sphinx'

    86 

    87 # A list of ignored prefixes for module index sorting.

    88 #modindex_common_prefix = []

    89 

    90 

    91 # -- Options for HTML output ---------------------------------------------------

    92 

    93 # The theme to use for HTML and HTML Help pages.  See the documentation for

    94 # a list of builtin themes.

    95 html_theme = 'default'

    96 

    97 # Theme options are theme-specific and customize the look and feel of a theme

    98 # further.  For a list of options available for each theme, see the

    99 # documentation.

   100 #html_theme_options = {}

   101 html_theme_options = {

   102     'footerbgcolor': '#4C4C4C',

   103     'sidebarbgcolor': '#DDDDCC',

   104     'sidebartextcolor': '#4F4F4F',

   105     'sidebarlinkcolor': '#333399',

   106     'relbarbgcolor': '#993333',

   107 }

   108 

   109 # Add any paths that contain custom themes here, relative to this directory.

   110 #html_theme_path = []

   111 

   112 # The name for this set of Sphinx documents.  If None, it defaults to

   113 # "<project> v<release> documentation".

   114 #html_title = None

   115 

   116 # A shorter title for the navigation bar.  Default is the same as html_title.

   117 #html_short_title = None

   118 

   119 # The name of an image file (relative to this directory) to place at the top

   120 # of the sidebar.

   121 #html_logo = None

   122 

   123 # The name of an image file (within the static path) to use as favicon of the

   124 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32

   125 # pixels large.

   126 #html_favicon = None

   127 

   128 # Add any paths that contain custom static files (such as style sheets) here,

   129 # relative to this directory. They are copied after the builtin static files,

   130 # so a file named "default.css" will overwrite the builtin "default.css".

   131 #html_static_path = ['_static']

   132 

   133 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

   134 # using the given strftime format.

   135 #html_last_updated_fmt = '%b %d, %Y'

   136 

   137 # If true, SmartyPants will be used to convert quotes and dashes to

   138 # typographically correct entities.

   139 #html_use_smartypants = True

   140 

   141 # Custom sidebar templates, maps document names to template names.

   142 #html_sidebars = {}

   143 

   144 # Additional templates that should be rendered to pages, maps page names to

   145 # template names.

   146 #html_additional_pages = {}

   147 

   148 # If false, no module index is generated.

   149 #html_domain_indices = True

   150 

   151 # If false, no index is generated.

   152 #html_use_index = True

   153 

   154 # If true, the index is split into individual pages for each letter.

   155 #html_split_index = False

   156 

   157 # If true, links to the reST sources are added to the pages.

   158 #html_show_sourcelink = True

   159 

   160 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.

   161 #html_show_sphinx = True

   162 

   163 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.

   164 #html_show_copyright = True

   165 

   166 # If true, an OpenSearch description file will be output, and all pages will

   167 # contain a <link> tag referring to it.  The value of this option must be the

   168 # base URL from which the finished HTML is served.

   169 #html_use_opensearch = ''

   170 

   171 # This is the file name suffix for HTML files (e.g. ".xhtml").

   172 #html_file_suffix = None

   173 

   174 # Output file base name for HTML help builder.

   175 htmlhelp_basename = 'PublidocDoc'

   176 

   177 

   178 # -- Options for LaTeX output --------------------------------------------------

   179 

   180 # The paper size ('letter' or 'a4').

   181 #latex_paper_size = 'letter'

   182 

   183 # The font size ('10pt', '11pt' or '12pt').

   184 #latex_font_size = '10pt'

   185 

   186 # Grouping the document tree into LaTeX files. List of tuples

   187 # (source start file, target name, title, author, documentclass [howto/manual]).

   188 latex_documents = [

   189   ('index', 'publidoc.tex', u'Publidoc Documentation',

   190    u'Prismallia', 'manual'),

   191 ]

   192 

   193 # The name of an image file (relative to this directory) to place at the top of

   194 # the title page.

   195 #latex_logo = None

   196 

   197 # For "manual" documents, if this is true, then toplevel headings are parts,

   198 # not chapters.

   199 #latex_use_parts = False

   200 

   201 # If true, show page references after internal links.

   202 #latex_show_pagerefs = False

   203 

   204 # If true, show URL addresses after external links.

   205 #latex_show_urls = False

   206 

   207 # Additional stuff for the LaTeX preamble.

   208 #latex_preamble = ''

   209 

   210 # Documents to append as an appendix to all manuals.

   211 #latex_appendices = []

   212 

   213 # If false, no module index is generated.

   214 #latex_domain_indices = True

   215 

   216 

   217 # -- Options for manual page output --------------------------------------------

   218 

   219 # One entry per manual page. List of tuples

   220 # (source start file, name, description, authors, manual section).

   221 man_pages = [

   222     ('index', 'publidoc', u'Publidoc Documentation',

   223      [u'Prismallia'], 1)

   224 ]

   225 

   226 

   227 # -- Options for Epub output ---------------------------------------------------

   228 

   229 # Bibliographic Dublin Core info.

   230 epub_title = u'Publidoc'

   231 epub_author = u'Patrick PIERRE'

   232 epub_publisher = u'Prismallia'

   233 epub_copyright = u'2011, Prismallia'

   234 

   235 # The language of the text. It defaults to the language option

   236 # or en if the language is not set.

   237 #epub_language = ''

   238 

   239 # The scheme of the identifier. Typical schemes are ISBN or URL.

   240 #epub_scheme = ''

   241 

   242 # The unique identifier of the text. This can be a ISBN number

   243 # or the project homepage.

   244 #epub_identifier = ''

   245 

   246 # A unique identification for the text.

   247 #epub_uid = ''

   248 

   249 # HTML files that should be inserted before the pages created by sphinx.

   250 # The format is a list of tuples containing the path and title.

   251 #epub_pre_files = []

   252 

   253 # HTML files shat should be inserted after the pages created by sphinx.

   254 # The format is a list of tuples containing the path and title.

   255 #epub_post_files = []

   256 

   257 # A list of files that should not be packed into the epub file.

   258 #epub_exclude_files = []

   259 

   260 # The depth of the table of contents in toc.ncx.

   261 #epub_tocdepth = 3

   262 

   263 # Allow duplicate toc entries.

   264 #epub_tocdup = True