Newer
Older
# -*- coding: utf-8 -*-
#
# GooCalendar documentation build configuration file, created by
# sphinx-quickstart on Mon Aug 13 13:24:40 2012.
#
# 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.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# -- General configuration ----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# 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.todo', 'sphinx.ext.intersphinx']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
# The master toctree document.
master_doc = 'index'
# General information about the project.
copyright = u'2019, Samuel Abels, Cédric Krier, Antoine Smolders'
# 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.
# The full version, including alpha/beta/rc tags.
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# Else, today_fmt is used as the format for a strftime call.
# List of patterns, relative to source directory, that match files and
# 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
# If true, '()' will be appended to :func: etc. cross-reference text.
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# 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.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
intersphinx_mapping = {
'python': ('https://docs.python.org/', None),
}
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
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.
# 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".
# 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.
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# 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".
# html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# Custom sidebar templates, maps document names to template names.
# Additional templates that should be rendered to pages, maps page names to
# template names.
# 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.
htmlhelp_basename = 'GooCalendardoc'
# -- Options for LaTeX output -------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual])
latex_documents = [
('index', 'GooCalendar.tex', 'GooCalendar Documentation',
u'Samuel Abels, Cédric Krier, Antoine Smolders', 'manual'),
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# If true, show page references after internal links.
# If true, show URL addresses after external links.
# Documents to append as an appendix to all manuals.
# -- Options for manual page output -------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'goocalendar', 'GooCalendar Documentation',
[u'Samuel Abels, Cédric Krier, Antoine Smolders'], 1)
# If true, show URL addresses after external links.
# -- 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', 'GooCalendar', 'GooCalendar Documentation',
u'Samuel Abels, Cédric Krier, Antoine Smolders', 'GooCalendar',
# Documents to append as an appendix to all manuals.
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# -- Options for Epub output --------------------------------------------------
# Bibliographic Dublin Core info.
epub_author = u'Samuel Abels, Cédric Krier, Antoine Smolders'
epub_publisher = u'Samuel Abels, Cédric Krier, Antoine Smolders'
epub_copyright = u'2019, Samuel Abels, Cédric Krier, Antoine Smolders'
# 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 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.