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