patrick@5: # -*- coding: utf-8 -*- patrick@5: # patrick@5: # Publidoc documentation build configuration file, created by patrick@5: # sphinx-quickstart on Mon Jun 6 08:40:53 2011. patrick@5: # patrick@5: # This file is execfile()d with the current directory set to its containing dir. patrick@5: # patrick@5: # Note that not all possible configuration values are present in this patrick@5: # autogenerated file. patrick@5: # patrick@5: # All configuration values have a default; values that are commented out patrick@5: # serve to show the default. patrick@5: patrick@5: import sys, os patrick@5: patrick@5: # If extensions (or modules to document with autodoc) are in another directory, patrick@5: # add these directories to sys.path here. If the directory is relative to the patrick@5: # documentation root, use os.path.abspath to make it absolute, like shown here. patrick@5: #sys.path.insert(0, os.path.abspath('.')) patrick@5: patrick@5: # -- General configuration ----------------------------------------------------- patrick@5: patrick@5: # If your documentation needs a minimal Sphinx version, state it here. patrick@5: #needs_sphinx = '1.0' patrick@5: patrick@5: # Add any Sphinx extension module names here, as strings. They can be extensions patrick@5: # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. patrick@5: #extensions = ['sphinx.ext.pngmath'] patrick@5: patrick@5: # Add any paths that contain templates here, relative to this directory. patrick@5: #templates_path = ['_templates'] patrick@5: patrick@5: # The suffix of source filenames. patrick@5: source_suffix = '.rst' patrick@5: patrick@5: # The encoding of source files. patrick@5: #source_encoding = 'utf-8-sig' patrick@5: patrick@5: # The master toctree document. patrick@5: master_doc = 'index' patrick@5: patrick@5: # General information about the project. patrick@5: project = u'Publidoc' patrick@5: copyright = u'2011, Prismallia' patrick@5: patrick@5: # The version info for the project you're documenting, acts as replacement for patrick@5: # |version| and |release|, also used in various other places throughout the patrick@5: # built documents. patrick@5: # patrick@5: # The short X.Y version. patrick@5: version = '1.0' patrick@5: # The full version, including alpha/beta/rc tags. patrick@5: release = '1.0' patrick@5: patrick@5: # The language for content autogenerated by Sphinx. Refer to documentation patrick@5: # for a list of supported languages. patrick@5: #language = None patrick@5: language = 'fr' patrick@5: patrick@5: # There are two options for replacing |today|: either, you set today to some patrick@5: # non-false value, then it is used: patrick@5: #today = '' patrick@5: # Else, today_fmt is used as the format for a strftime call. patrick@5: #today_fmt = '%B %d, %Y' patrick@5: patrick@5: # List of patterns, relative to source directory, that match files and patrick@5: # directories to ignore when looking for source files. patrick@5: exclude_patterns = [] patrick@5: patrick@5: # The reST default role (used for this markup: `text`) to use for all documents. patrick@5: #default_role = None patrick@5: patrick@5: # If true, '()' will be appended to :func: etc. cross-reference text. patrick@5: #add_function_parentheses = True patrick@5: patrick@5: # If true, the current module name will be prepended to all description patrick@5: # unit titles (such as .. function::). patrick@5: #add_module_names = True patrick@5: patrick@5: # If true, sectionauthor and moduleauthor directives will be shown in the patrick@5: # output. They are ignored by default. patrick@5: #show_authors = False patrick@5: patrick@5: # The name of the Pygments (syntax highlighting) style to use. patrick@5: pygments_style = 'sphinx' patrick@5: patrick@5: # A list of ignored prefixes for module index sorting. patrick@5: #modindex_common_prefix = [] patrick@5: patrick@5: patrick@5: # -- Options for HTML output --------------------------------------------------- patrick@5: patrick@5: # The theme to use for HTML and HTML Help pages. See the documentation for patrick@5: # a list of builtin themes. patrick@5: html_theme = 'default' patrick@5: patrick@5: # Theme options are theme-specific and customize the look and feel of a theme patrick@5: # further. For a list of options available for each theme, see the patrick@5: # documentation. patrick@5: #html_theme_options = {} patrick@5: html_theme_options = { patrick@5: 'footerbgcolor': '#4C4C4C', patrick@5: 'sidebarbgcolor': '#DDDDCC', patrick@5: 'sidebartextcolor': '#4F4F4F', patrick@5: 'sidebarlinkcolor': '#333399', patrick@5: 'relbarbgcolor': '#993333', patrick@5: } patrick@5: patrick@5: # Add any paths that contain custom themes here, relative to this directory. patrick@5: #html_theme_path = [] patrick@5: patrick@5: # The name for this set of Sphinx documents. If None, it defaults to patrick@5: # " v documentation". patrick@5: #html_title = None patrick@5: patrick@5: # A shorter title for the navigation bar. Default is the same as html_title. patrick@5: #html_short_title = None patrick@5: patrick@5: # The name of an image file (relative to this directory) to place at the top patrick@5: # of the sidebar. patrick@5: #html_logo = None patrick@5: patrick@5: # The name of an image file (within the static path) to use as favicon of the patrick@5: # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 patrick@5: # pixels large. patrick@5: #html_favicon = None patrick@5: patrick@5: # Add any paths that contain custom static files (such as style sheets) here, patrick@5: # relative to this directory. They are copied after the builtin static files, patrick@5: # so a file named "default.css" will overwrite the builtin "default.css". patrick@5: #html_static_path = ['_static'] patrick@5: patrick@5: # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, patrick@5: # using the given strftime format. patrick@5: #html_last_updated_fmt = '%b %d, %Y' patrick@5: patrick@5: # If true, SmartyPants will be used to convert quotes and dashes to patrick@5: # typographically correct entities. patrick@5: #html_use_smartypants = True patrick@5: patrick@5: # Custom sidebar templates, maps document names to template names. patrick@5: #html_sidebars = {} patrick@5: patrick@5: # Additional templates that should be rendered to pages, maps page names to patrick@5: # template names. patrick@5: #html_additional_pages = {} patrick@5: patrick@5: # If false, no module index is generated. patrick@5: #html_domain_indices = True patrick@5: patrick@5: # If false, no index is generated. patrick@5: #html_use_index = True patrick@5: patrick@5: # If true, the index is split into individual pages for each letter. patrick@5: #html_split_index = False patrick@5: patrick@5: # If true, links to the reST sources are added to the pages. patrick@5: #html_show_sourcelink = True patrick@5: patrick@5: # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. patrick@5: #html_show_sphinx = True patrick@5: patrick@5: # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. patrick@5: #html_show_copyright = True patrick@5: patrick@5: # If true, an OpenSearch description file will be output, and all pages will patrick@5: # contain a tag referring to it. The value of this option must be the patrick@5: # base URL from which the finished HTML is served. patrick@5: #html_use_opensearch = '' patrick@5: patrick@5: # This is the file name suffix for HTML files (e.g. ".xhtml"). patrick@5: #html_file_suffix = None patrick@5: patrick@5: # Output file base name for HTML help builder. patrick@5: htmlhelp_basename = 'PublidocDoc' patrick@5: patrick@5: patrick@5: # -- Options for LaTeX output -------------------------------------------------- patrick@5: patrick@5: # The paper size ('letter' or 'a4'). patrick@5: #latex_paper_size = 'letter' patrick@5: patrick@5: # The font size ('10pt', '11pt' or '12pt'). patrick@5: #latex_font_size = '10pt' patrick@5: patrick@5: # Grouping the document tree into LaTeX files. List of tuples patrick@5: # (source start file, target name, title, author, documentclass [howto/manual]). patrick@5: latex_documents = [ patrick@5: ('index', 'publidoc.tex', u'Publidoc Documentation', patrick@5: u'Prismallia', 'manual'), patrick@5: ] patrick@5: patrick@5: # The name of an image file (relative to this directory) to place at the top of patrick@5: # the title page. patrick@5: #latex_logo = None patrick@5: patrick@5: # For "manual" documents, if this is true, then toplevel headings are parts, patrick@5: # not chapters. patrick@5: #latex_use_parts = False patrick@5: patrick@5: # If true, show page references after internal links. patrick@5: #latex_show_pagerefs = False patrick@5: patrick@5: # If true, show URL addresses after external links. patrick@5: #latex_show_urls = False patrick@5: patrick@5: # Additional stuff for the LaTeX preamble. patrick@5: #latex_preamble = '' patrick@5: patrick@5: # Documents to append as an appendix to all manuals. patrick@5: #latex_appendices = [] patrick@5: patrick@5: # If false, no module index is generated. patrick@5: #latex_domain_indices = True patrick@5: patrick@5: patrick@5: # -- Options for manual page output -------------------------------------------- patrick@5: patrick@5: # One entry per manual page. List of tuples patrick@5: # (source start file, name, description, authors, manual section). patrick@5: man_pages = [ patrick@5: ('index', 'publidoc', u'Publidoc Documentation', patrick@5: [u'Prismallia'], 1) patrick@5: ] patrick@5: patrick@5: patrick@5: # -- Options for Epub output --------------------------------------------------- patrick@5: patrick@5: # Bibliographic Dublin Core info. patrick@5: epub_title = u'Publidoc' patrick@5: epub_author = u'Patrick PIERRE' patrick@5: epub_publisher = u'Prismallia' patrick@5: epub_copyright = u'2011, Prismallia' patrick@5: patrick@5: # The language of the text. It defaults to the language option patrick@5: # or en if the language is not set. patrick@5: #epub_language = '' patrick@5: patrick@5: # The scheme of the identifier. Typical schemes are ISBN or URL. patrick@5: #epub_scheme = '' patrick@5: patrick@5: # The unique identifier of the text. This can be a ISBN number patrick@5: # or the project homepage. patrick@5: #epub_identifier = '' patrick@5: patrick@5: # A unique identification for the text. patrick@5: #epub_uid = '' patrick@5: patrick@5: # HTML files that should be inserted before the pages created by sphinx. patrick@5: # The format is a list of tuples containing the path and title. patrick@5: #epub_pre_files = [] patrick@5: patrick@5: # HTML files shat should be inserted after the pages created by sphinx. patrick@5: # The format is a list of tuples containing the path and title. patrick@5: #epub_post_files = [] patrick@5: patrick@5: # A list of files that should not be packed into the epub file. patrick@5: #epub_exclude_files = [] patrick@5: patrick@5: # The depth of the table of contents in toc.ncx. patrick@5: #epub_tocdepth = 3 patrick@5: patrick@5: # Allow duplicate toc entries. patrick@5: #epub_tocdup = True