404
+ − 1 # -*- coding: utf-8 -*-
+ − 2 #
+ − 3 # Configuration file for the Sphinx documentation builder.
+ − 4 #
+ − 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
+ − 8
+ − 9 # -- Path setup --------------------------------------------------------------
+ − 10
+ − 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.
+ − 14 #
+ − 15 # import os
+ − 16 # import sys
+ − 17 # sys.path.insert(0, os.path.abspath('.'))
+ − 18
+ − 19
+ − 20 # -- Project information -----------------------------------------------------
+ − 21
+ − 22 project = u 'SàT PubSub'
+ − 23 copyright = u '2019, Jérôme Poisson'
+ − 24 author = u 'Jérôme Poisson'
+ − 25
+ − 26 # The short X.Y version
+ − 27 version = u ''
+ − 28 # The full version, including alpha/beta/rc tags
+ − 29 release = u '0.3.0'
+ − 30
+ − 31
+ − 32 # -- General configuration ---------------------------------------------------
+ − 33
+ − 34 # If your documentation needs a minimal Sphinx version, state it here.
+ − 35 #
+ − 36 # needs_sphinx = '1.0'
+ − 37
+ − 38 # Add any Sphinx extension module names here, as strings. They can be
+ − 39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+ − 40 # ones.
+ − 41 extensions = [
+ − 42 ]
+ − 43
+ − 44 # Add any paths that contain templates here, relative to this directory.
+ − 45 templates_path = [ '.templates' ]
+ − 46
+ − 47 # The suffix(es) of source filenames.
+ − 48 # You can specify multiple suffix as a list of string:
+ − 49 #
+ − 50 # source_suffix = ['.rst', '.md']
+ − 51 source_suffix = '.rst'
+ − 52
+ − 53 # The master toctree document.
+ − 54 master_doc = 'index'
+ − 55
+ − 56 # The language for content autogenerated by Sphinx. Refer to documentation
+ − 57 # for a list of supported languages.
+ − 58 #
+ − 59 # This is also used if you do content translation via gettext catalogs.
+ − 60 # Usually you set "language" from the command line for these cases.
+ − 61 language = None
+ − 62
+ − 63 # List of patterns, relative to source directory, that match files and
+ − 64 # directories to ignore when looking for source files.
+ − 65 # This pattern also affects html_static_path and html_extra_path.
+ − 66 exclude_patterns = [ u '.build' , 'Thumbs.db' , '.DS_Store' ]
+ − 67
+ − 68 # The name of the Pygments (syntax highlighting) style to use.
+ − 69 pygments_style = None
+ − 70
+ − 71
+ − 72 # -- Options for HTML output -------------------------------------------------
+ − 73
+ − 74 # The theme to use for HTML and HTML Help pages. See the documentation for
+ − 75 # a list of builtin themes.
+ − 76 #
+ − 77 html_theme = 'alabaster'
+ − 78
+ − 79 # Theme options are theme-specific and customize the look and feel of a theme
+ − 80 # further. For a list of options available for each theme, see the
+ − 81 # documentation.
+ − 82 #
+ − 83 # html_theme_options = {}
+ − 84
+ − 85 # Add any paths that contain custom static files (such as style sheets) here,
+ − 86 # relative to this directory. They are copied after the builtin static files,
+ − 87 # so a file named "default.css" will overwrite the builtin "default.css".
+ − 88 html_static_path = [ '.static' ]
+ − 89
+ − 90 # Custom sidebar templates, must be a dictionary that maps document names
+ − 91 # to template names.
+ − 92 #
+ − 93 # The default sidebars (for documents that don't match any pattern) are
+ − 94 # defined by theme itself. Builtin themes are using these templates by
+ − 95 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+ − 96 # 'searchbox.html']``.
+ − 97 #
+ − 98 # html_sidebars = {}
+ − 99
+ − 100
+ − 101 # -- Options for HTMLHelp output ---------------------------------------------
+ − 102
+ − 103 # Output file base name for HTML help builder.
+ − 104 htmlhelp_basename = 'STPubSubdoc'
+ − 105
+ − 106
+ − 107 # -- Options for LaTeX output ------------------------------------------------
+ − 108
+ − 109 latex_elements = {
+ − 110 # The paper size ('letterpaper' or 'a4paper').
+ − 111 #
+ − 112 # 'papersize': 'letterpaper',
+ − 113
+ − 114 # The font size ('10pt', '11pt' or '12pt').
+ − 115 #
+ − 116 # 'pointsize': '10pt',
+ − 117
+ − 118 # Additional stuff for the LaTeX preamble.
+ − 119 #
+ − 120 # 'preamble': '',
+ − 121
+ − 122 # Latex figure (float) alignment
+ − 123 #
+ − 124 # 'figure_align': 'htbp',
+ − 125 }
+ − 126
+ − 127 # Grouping the document tree into LaTeX files. List of tuples
+ − 128 # (source start file, target name, title,
+ − 129 # author, documentclass [howto, manual, or own class]).
+ − 130 latex_documents = [
+ − 131 ( master_doc , 'STPubSub.tex' , u 'SàT PubSub Documentation' ,
+ − 132 u 'Jérôme Poisson' , 'manual' ),
+ − 133 ]
+ − 134
+ − 135
+ − 136 # -- Options for manual page output ------------------------------------------
+ − 137
+ − 138 # One entry per manual page. List of tuples
+ − 139 # (source start file, name, description, authors, manual section).
+ − 140 man_pages = [
+ − 141 ( master_doc , 'stpubsub' , u 'SàT PubSub Documentation' ,
+ − 142 [ author ], 1 )
+ − 143 ]
+ − 144
+ − 145
+ − 146 # -- Options for Texinfo output ----------------------------------------------
+ − 147
+ − 148 # Grouping the document tree into Texinfo files. List of tuples
+ − 149 # (source start file, target name, title, author,
+ − 150 # dir menu entry, description, category)
+ − 151 texinfo_documents = [
+ − 152 ( master_doc , 'STPubSub' , u 'SàT PubSub Documentation' ,
+ − 153 author , 'STPubSub' , 'One line description of project.' ,
+ − 154 'Miscellaneous' ),
+ − 155 ]
+ − 156
+ − 157
+ − 158 # -- Options for Epub output -------------------------------------------------
+ − 159
+ − 160 # Bibliographic Dublin Core info.
+ − 161 epub_title = project
+ − 162
+ − 163 # The unique identifier of the text. This can be a ISBN number
+ − 164 # or the project homepage.
+ − 165 #
+ − 166 # epub_identifier = ''
+ − 167
+ − 168 # A unique identification for the text.
+ − 169 #
+ − 170 # epub_uid = ''
+ − 171
+ − 172 # A list of files that should not be packed into the epub file.
+ − 173 epub_exclude_files = [ 'search.html' ]
