1 # -*- coding: utf-8 -*-
3 # Configuration file for the Sphinx documentation builder.
5 # This file does only contain a selection of the most common options. For a
6 # full list see the documentation:
7 # http://www.sphinx-doc.org/en/master/config
9 # -- Path setup --------------------------------------------------------------
11 # If extensions (or modules to document with autodoc) are in another directory,
12 # add these directories to sys.path here. If the directory is relative to the
13 # documentation root, use os.path.abspath to make it absolute, like shown here.
17 sys.path.insert(0, os.path.abspath('../..'))
18 from sid import __author__, __version__
20 # -- Project information -----------------------------------------------------
23 from datetime import datetime
24 copyright = u'2011-{}, {}'.format(datetime.now().year, __author__)
27 # The short X.Y version
29 # The full version, including alpha/beta/rc tags
30 release = ".".join(__version__.split(".")[0:2])
33 # -- General configuration ---------------------------------------------------
35 # If your documentation needs a minimal Sphinx version, state it here.
37 # need 2.0 at least for "autodecorator"
40 # Add any Sphinx extension module names here, as strings. They can be
41 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
45 'sphinx.ext.intersphinx',
46 'sphinx.ext.coverage',
47 'sphinx.ext.viewcode',
50 # Add any paths that contain templates here, relative to this directory.
51 templates_path = ['_templates']
53 # The suffix(es) of source filenames.
54 # You can specify multiple suffix as a list of string:
56 # source_suffix = ['.rst', '.md']
57 source_suffix = '.rst'
59 # The master toctree document.
62 # The language for content autogenerated by Sphinx. Refer to documentation
63 # for a list of supported languages.
65 # This is also used if you do content translation via gettext catalogs.
66 # Usually you set "language" from the command line for these cases.
69 # List of patterns, relative to source directory, that match files and
70 # directories to ignore when looking for source files.
71 # This pattern also affects html_static_path and html_extra_path.
74 # The name of the Pygments (syntax highlighting) style to use.
75 pygments_style = 'sphinx'
78 # -- Options for HTML output -------------------------------------------------
80 # The theme to use for HTML and HTML Help pages. See the documentation for
81 # a list of builtin themes.
83 #html_theme = 'sphinx_rtd_theme'
84 #html_theme_options = {
85 # 'prev_next_buttons_location': 'both',
86 # 'style_external_links': True,
88 html_theme = 'alabaster'
89 html_theme_options = {
90 'donate_url': 'https://liberapay.com/kaliko/',
91 'style_external_links': True,
93 html_show_sphinx = False
95 # Theme options are theme-specific and customize the look and feel of a theme
96 # further. For a list of options available for each theme, see the
99 # html_theme_options = {}
101 # Add any paths that contain custom static files (such as style sheets) here,
102 # relative to this directory. They are copied after the builtin static files,
103 # so a file named "default.css" will overwrite the builtin "default.css".
104 html_static_path = ['_static']
106 # Custom sidebar templates, must be a dictionary that maps document names
109 # The default sidebars (for documents that don't match any pattern) are
110 # defined by theme itself. Builtin themes are using these templates by
111 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
112 # 'searchbox.html']``.
117 # -- Options for HTMLHelp output ---------------------------------------------
119 # Output file base name for HTML help builder.
120 htmlhelp_basename = 'sidxmppbotdoc'
123 # -- Options for LaTeX output ------------------------------------------------
126 # The paper size ('letterpaper' or 'a4paper').
128 # 'papersize': 'letterpaper',
130 # The font size ('10pt', '11pt' or '12pt').
132 # 'pointsize': '10pt',
134 # Additional stuff for the LaTeX preamble.
138 # Latex figure (float) alignment
140 # 'figure_align': 'htbp',
143 # Grouping the document tree into LaTeX files. List of tuples
144 # (source start file, target name, title,
145 # author, documentclass [howto, manual, or own class]).
147 (master_doc, 'sidxmppbot.tex', 'sid xmpp bot Documentation',
152 # -- Options for manual page output ------------------------------------------
154 # One entry per manual page. List of tuples
155 # (source start file, name, description, authors, manual section).
157 (master_doc, 'sidxmppbot', 'sid xmpp bot Documentation',
162 # -- Options for Texinfo output ----------------------------------------------
164 # Grouping the document tree into Texinfo files. List of tuples
165 # (source start file, target name, title, author,
166 # dir menu entry, description, category)
167 texinfo_documents = [
168 (master_doc, 'sidxmppbot', 'sid xmpp bot Documentation',
169 author, 'sidxmppbot', 'One line description of project.',
174 # -- Options for Epub output -------------------------------------------------
176 # Bibliographic Dublin Core info.
179 # The unique identifier of the text. This can be a ISBN number
180 # or the project homepage.
182 # epub_identifier = ''
184 # A unique identification for the text.
188 # A list of files that should not be packed into the epub file.
189 epub_exclude_files = ['search.html']
192 # -- Extension configuration -------------------------------------------------
194 # -- Options for intersphinx extension ---------------------------------------
196 # Example configuration for intersphinx: refer to the Python standard library.
197 intersphinx_mapping = {'https://docs.python.org/': None}