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