conf Module

conf.needs_sphinx = '1.1'

– General configuration —————————————————– If your documentation needs a minimal Sphinx version, state it here.

conf.extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.doctest', 'sphinx.ext.coverage']

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.todo’, ‘sphinx.ext.viewcode’]

conf.templates_path = ['_templates']

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

conf.source_suffix = '.rst'

The suffix of source filenames.

conf.master_doc = 'index'

The encoding of source files. The master toctree document.

conf.project = u'MPRI Bomberman'

General information about the project.

conf.version = '1.2'

The version info for the project you’re documenting, acts as replacement for 1.2 and public, also used in various other places throughout the built documents. The short X.Y version.

conf.release = 'public'

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

conf.today = ''

The language for content autogenerated by Sphinx. Refer to documentation for a list of supported languages. There are two options for replacing Wednesday 26/06/2013, at 12h:00m:32s: either, you set today to some non-false value, then it is used:

conf.today_fmt = '%A %d/%m/%Y, at %Hh:%Mm:%Ss'

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

conf.exclude_patterns = ['_build']

List of patterns, relative to source directory, that match files and directories to ignore when looking for source files.

conf.add_function_parentheses = True

The reST default role (used for this markup: text) to use for all documents. If true, ‘()’ will be appended to :func: etc. cross-reference text.

conf.add_module_names = True

If true, the current module name will be prepended to all description unit titles (such as .. function::).

conf.pygments_style = 'sphinx'

If true, sectionauthor and moduleauthor directives will be shown in the output. They are ignored by default. The name of the Pygments (syntax highlighting) style to use.

conf.html_theme = 'default'

A list of ignored prefixes for module index sorting. – Options for HTML output ————————————————— The theme to use for HTML and HTML Help pages. See the documentation for a list of builtin themes.

conf.html_title = 'MPRI Bomberman (V1.2, release public) : HTML documentation'

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. Add any paths that contain custom themes here, relative to this directory. The name for this set of Sphinx documents. If None, it defaults to “<project> v<release> documentation”.

conf.html_logo = 'images/bomberman.gif'

A shorter title for the navigation bar. Default is the same as html_title. The name of an image file (relative to this directory) to place at the top of the sidebar.

conf.html_favicon = 'images/bomberman.gif'

FIXME set to .ico if it doesn’t work.

conf.html_static_path = ['_static']

Add any paths that contain custom static files (such as style sheets) here, relative to this directory. They are copied after the builtin static files, so a file named “default.css” will overwrite the builtin “default.css”.

conf.html_last_updated_fmt = '%b %d, %Y'

If not ‘’, a ‘Last updated on:’ timestamp is inserted at every page bottom, using the given strftime format.

conf.html_use_smartypants = True

If true, SmartyPants will be used to convert quotes and dashes to typographically correct entities.

conf.htmlhelp_basename = 'MPRI_Bomberman_doc'

Custom sidebar templates, maps document names to template names. Additional templates that should be rendered to pages, maps page names to template names. If false, no module index is generated. If false, no index is generated. If true, the index is split into individual pages for each letter. If true, links to the reST sources are added to the pages. If true, “Created using Sphinx” is shown in the HTML footer. Default is True. If true, “(C) Copyright ...” is shown in the HTML footer. Default is True. If true, an OpenSearch description file will be output, and all pages will contain a <link> tag referring to it. The value of this option must be the base URL from which the finished HTML is served. This is the file name suffix for HTML files (e.g. ”.xhtml”). Output file base name for HTML help builder.

conf.latex_elements = {}

– Options for LaTeX output ————————————————–

conf.latex_documents = [('rapport', 'MPRI_Bomberman_rapport.tex', u'MPRI Bomberman Rapport', u'Lilian Besson (mailto:lbesson@ens-cachan.fr)', 'manual')]

Grouping the document tree into LaTeX files. List of tuples (source start file, target name, title, author, documentclass [howto/manual]).

conf.latex_logo = 'images/bomberman.png'

The name of an image file (relative to this directory) to place at the top of the title page.

conf.latex_use_parts = True

For “manual” documents, if this is true, then toplevel headings are parts, not chapters.

conf.latex_show_urls = True

If true, show page references after internal links. If true, show URL addresses after external links.

conf.man_pages = [('index', 'mpri_bomberman_doc', u'MPRI Bomberman Documentation', [u'Lilian Besson (mailto:lbesson@ens-cachan.fr)'], 1), ('BombermanClient', 'client', u'Documentation for BombermanClient', [u'Lilian Besson (mailto:lbesson@ens-cachan.fr)'], 2), ('BombermanServer', 'server', u'Documentation for BombermanServer', [u'Lilian Besson (mailto:lbesson@ens-cachan.fr)'], 3), ('IA_Bomberman', 'ia', u'Documentation for IA_Bomberman', [u'Lilian Besson (mailto:lbesson@ens-cachan.fr)'], 3)]

Documents to append as an appendix to all manuals. If false, no module index is generated. – Options for manual page output ——————————————– One entry per manual page. List of tuples (source start file, name, description, authors, manual section).

conf.man_show_urls = True

If true, show URL addresses after external links.

conf.texinfo_documents = [('index', 'MPRI_Bomberman_doc', u'MPRI Bomberman Documentation', u'Lilian Besson (mailto:lbesson@ens-cachan.fr)', 'MPRI_Bomberman_doc', 'One line description of project.', 'Miscellaneous')]

– 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)

conf.epub_title = u'MPRI Bomberman'

Documents to append as an appendix to all manuals. If false, no module index is generated. How to display URL addresses: ‘footnote’, ‘no’, or ‘inline’. – Options for Epub output ————————————————— Bibliographic Dublin Core info.

conf.autodoc_member_order = 'bysource'

The language of the text. It defaults to the language option or en if the language is not set. The scheme of the identifier. Typical schemes are ISBN or URL. The unique identifier of the text. This can be a ISBN number or the project homepage. A unique identification for the text. A tuple containing the cover image and cover page html template filenames. HTML files that should be inserted before the pages created by sphinx. The format is a list of tuples containing the path and title. HTML files shat should be inserted after the pages created by sphinx. The format is a list of tuples containing the path and title. A list of files that should not be packed into the epub file. The depth of the table of contents in toc.ncx. Allow duplicate toc entries. Pour trier dans l’ordre du code et non pas par ordre alphabétique Merci à Vincent Le Gallic pour ça.