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 = 'TPC-H for PostgreSQL'
23+ copyright = '2018, Sohaib Iftakhar, Slavo Nagy'
24+ author = 'Sohaib Iftakhar, Slavo Nagy'
25+
26+ # The short X.Y version
27+ version = ''
28+ # The full version, including alpha/beta/rc tags
29+ release = '0.1'
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+ 'sphinx.ext.todo' ,
43+ 'sphinx.ext.coverage' ,
44+ ]
45+
46+ # Add any paths that contain templates here, relative to this directory.
47+ templates_path = ['_templates' ]
48+
49+ # The suffix(es) of source filenames.
50+ # You can specify multiple suffix as a list of string:
51+ #
52+ # source_suffix = ['.rst', '.md']
53+ source_suffix = '.rst'
54+
55+ # The master toctree document.
56+ master_doc = 'index'
57+
58+ # The language for content autogenerated by Sphinx. Refer to documentation
59+ # for a list of supported languages.
60+ #
61+ # This is also used if you do content translation via gettext catalogs.
62+ # Usually you set "language" from the command line for these cases.
63+ language = None
64+
65+ # List of patterns, relative to source directory, that match files and
66+ # directories to ignore when looking for source files.
67+ # This pattern also affects html_static_path and html_extra_path .
68+ exclude_patterns = []
69+
70+ # The name of the Pygments (syntax highlighting) style to use.
71+ pygments_style = 'sphinx'
72+
73+
74+ # -- Options for HTML output -------------------------------------------------
75+
76+ # The theme to use for HTML and HTML Help pages. See the documentation for
77+ # a list of builtin themes.
78+ #
79+ html_theme = 'alabaster'
80+
81+ # Theme options are theme-specific and customize the look and feel of a theme
82+ # further. For a list of options available for each theme, see the
83+ # documentation.
84+ #
85+ # html_theme_options = {}
86+
87+ # Add any paths that contain custom static files (such as style sheets) here,
88+ # relative to this directory. They are copied after the builtin static files,
89+ # so a file named "default.css" will overwrite the builtin "default.css".
90+ html_static_path = ['_static' ]
91+
92+ # Custom sidebar templates, must be a dictionary that maps document names
93+ # to template names.
94+ #
95+ # The default sidebars (for documents that don't match any pattern) are
96+ # defined by theme itself. Builtin themes are using these templates by
97+ # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
98+ # 'searchbox.html']``.
99+ #
100+ # html_sidebars = {}
101+
102+
103+ # -- Options for HTMLHelp output ---------------------------------------------
104+
105+ # Output file base name for HTML help builder.
106+ htmlhelp_basename = 'TPC-HforPostgreSQLdoc'
107+
108+
109+ # -- Options for LaTeX output ------------------------------------------------
110+
111+ latex_elements = {
112+ # The paper size ('letterpaper' or 'a4paper').
113+ #
114+ # 'papersize': 'letterpaper',
115+
116+ # The font size ('10pt', '11pt' or '12pt').
117+ #
118+ # 'pointsize': '10pt',
119+
120+ # Additional stuff for the LaTeX preamble.
121+ #
122+ # 'preamble': '',
123+
124+ # Latex figure (float) alignment
125+ #
126+ # 'figure_align': 'htbp',
127+ }
128+
129+ # Grouping the document tree into LaTeX files. List of tuples
130+ # (source start file, target name, title,
131+ # author, documentclass [howto, manual, or own class]).
132+ latex_documents = [
133+ (master_doc , 'TPC-HforPostgreSQL.tex' , 'TPC-H for PostgreSQL Documentation' ,
134+ 'Sohaib Iftakhar, Slavo Nagy' , 'manual' ),
135+ ]
136+
137+
138+ # -- Options for manual page output ------------------------------------------
139+
140+ # One entry per manual page. List of tuples
141+ # (source start file, name, description, authors, manual section).
142+ man_pages = [
143+ (master_doc , 'tpc-hforpostgresql' , 'TPC-H for PostgreSQL Documentation' ,
144+ [author ], 1 )
145+ ]
146+
147+
148+ # -- Options for Texinfo output ----------------------------------------------
149+
150+ # Grouping the document tree into Texinfo files. List of tuples
151+ # (source start file, target name, title, author,
152+ # dir menu entry, description, category)
153+ texinfo_documents = [
154+ (master_doc , 'TPC-HforPostgreSQL' , 'TPC-H for PostgreSQL Documentation' ,
155+ author , 'TPC-HforPostgreSQL' , 'One line description of project.' ,
156+ 'Miscellaneous' ),
157+ ]
158+
159+
160+ # -- Extension configuration -------------------------------------------------
161+
162+ # -- Options for todo extension ----------------------------------------------
163+
164+ # If true, `todo` and `todoList` produce output, else they produce nothing.
165+ todo_include_todos = True
0 commit comments