summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/conf.py')
-rw-r--r--doc/source/conf.py178
1 files changed, 178 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100644
index 0000000..b2af5f2
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,178 @@
1# -*- coding: utf-8 -*-
2#
3# Snuffleupagus documentation build configuration file, created by
4# sphinx-quickstart on Tue Jun 27 14:15:46 2017.
5#
6# This file is execfile()d with the current directory set to its
7# containing dir.
8#
9# Note that not all possible configuration values are present in this
10# autogenerated file.
11#
12# All configuration values have a default; values that are commented out
13# serve to show the default.
14
15# If extensions (or modules to document with autodoc) are in another directory,
16# add these directories to sys.path here. If the directory is relative to the
17# documentation root, use os.path.abspath to make it absolute, like shown here.
18#
19# import os
20# import sys
21# sys.path.insert(0, os.path.abspath('.'))
22from datetime import datetime
23
24
25# -- General configuration ------------------------------------------------
26
27# If your documentation needs a minimal Sphinx version, state it here.
28#
29# needs_sphinx = '1.0'
30
31# Add any Sphinx extension module names here, as strings. They can be
32# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33# ones.
34#extensions = ['sphinx.ext.githubpages']
35
36# Add any paths that contain templates here, relative to this directory.
37templates_path = ['_templates']
38
39# The suffix(es) of source filenames.
40# You can specify multiple suffix as a list of string:
41#
42# source_suffix = ['.rst', '.md']
43source_suffix = '.rst'
44
45# The master toctree document.
46master_doc = 'index'
47
48# General information about the project.
49project = u'Snuffleupagus'
50copyright = u'%d, NBS System' % datetime.now().year
51author = u'Sebastien Blot & Julien Voisin'
52
53# The version info for the project you're documenting, acts as replacement for
54# |version| and |release|, also used in various other places throughout the
55# built documents.
56#
57# The short X.Y version.
58version = u'0.1'
59# The full version, including alpha/beta/rc tags.
60release = u'Public Alpha'
61
62# The language for content autogenerated by Sphinx. Refer to documentation
63# for a list of supported languages.
64#
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.
67language = None
68
69# List of patterns, relative to source directory, that match files and
70# directories to ignore when looking for source files.
71# This patterns also effect to html_static_path and html_extra_path
72exclude_patterns = []
73
74# The name of the Pygments (syntax highlighting) style to use.
75pygments_style = 'manni'
76
77# If true, `todo` and `todoList` produce output, else they produce nothing.
78todo_include_todos = False
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#
86html_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
93html_sidebars = {
94 '**': [
95 'about.html',
96 'navigation.html',
97 'relations.html',
98 'searchbox.html',
99 #'donate.html',
100 ]
101}
102html_theme_options = {
103 'logo': './sp.jpg',
104 #'description': '<br>Killing bug-classes in PHP 7, virtual-patching the rest.',
105 #'fixed_sidebar': True,
106 'page_width': '60%',
107 'show_powered_by': False,
108 }
109
110sidebar_collapse = True
111
112# Add any paths that contain custom static files (such as style sheets) here,
113# relative to this directory. They are copied after the builtin static files,
114# so a file named "default.css" will overwrite the builtin "default.css".
115html_static_path = ['_static']
116
117#html_logo = './sp.png'
118
119html_show_sphinx = False
120
121# -- Options for HTMLHelp output ------------------------------------------
122
123# Output file base name for HTML help builder.
124htmlhelp_basename = 'Snuffleupagusdoc'
125
126
127# -- Options for LaTeX output ---------------------------------------------
128
129latex_elements = {
130 # The paper size ('letterpaper' or 'a4paper').
131 #
132 # 'papersize': 'letterpaper',
133
134 # The font size ('10pt', '11pt' or '12pt').
135 #
136 # 'pointsize': '10pt',
137
138 # Additional stuff for the LaTeX preamble.
139 #
140 # 'preamble': '',
141
142 # Latex figure (float) alignment
143 #
144 # 'figure_align': 'htbp',
145}
146
147# Grouping the document tree into LaTeX files. List of tuples
148# (source start file, target name, title,
149# author, documentclass [howto, manual, or own class]).
150latex_documents = [
151 (master_doc, 'Snuffleupagus.tex', u'Snuffleupagus Documentation',
152 u'Sebastien Blot \\& Julien Voisin', 'manual'),
153]
154
155
156# -- Options for manual page output ---------------------------------------
157
158# One entry per manual page. List of tuples
159# (source start file, name, description, authors, manual section).
160man_pages = [
161 (master_doc, 'snuffleupagus', u'Snuffleupagus Documentation',
162 [author], 1)
163]
164
165
166# -- Options for Texinfo output -------------------------------------------
167
168# Grouping the document tree into Texinfo files. List of tuples
169# (source start file, target name, title, author,
170# dir menu entry, description, category)
171texinfo_documents = [
172 (master_doc, 'Snuffleupagus', u'Snuffleupagus Documentation',
173 author, 'Snuffleupagus', 'One line description of project.',
174 'Miscellaneous'),
175]
176
177
178