source: flex_extract.git/documentation/Sphinx/source/conf.py @ 708c667

ctbtodev
Last change on this file since 708c667 was 708c667, checked in by Anne Philipp <anne.philipp@…>, 5 years ago

generated first sphinx instance and adapted code doctsrings for automated api generation for disaggregation module as a first test

  • Property mode set to 100644
File size: 5.4 KB
Line 
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#
15import os
16import sys
17sys.path.insert(0, os.path.abspath('../../../source/python'))
18sys.path.insert(0, os.path.abspath('../../../source/python/mods'))
19sys.path.insert(0, os.path.abspath('../../../source/python/classes'))
20
21
22
23# -- Project information -----------------------------------------------------
24
25project = u'flex_extract'
26copyright = u'2018, Anne Philipp and Leopold Haimberger'
27author = u'Anne Philipp and Leopold Haimberger'
28
29# The short X.Y version
30version = u'7.1'
31# The full version, including alpha/beta/rc tags
32release = u'7.1 alpha'
33
34
35# -- General configuration ---------------------------------------------------
36
37# If your documentation needs a minimal Sphinx version, state it here.
38#
39# needs_sphinx = '1.0'
40
41# Add any Sphinx extension module names here, as strings. They can be
42# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
43# ones.
44extensions = [
45    'sphinx.ext.napoleon',
46    'sphinx.ext.autodoc',
47    'sphinx.ext.autosectionlabel',
48    'sphinx.ext.todo',
49    'sphinx.ext.coverage',
50    'sphinx.ext.mathjax',
51    'sphinx.ext.ifconfig',
52    'sphinx.ext.viewcode',
53    'sphinx.ext.githubpages',
54]
55
56# Add any paths that contain templates here, relative to this directory.
57templates_path = ['_templates']
58
59# The suffix(es) of source filenames.
60# You can specify multiple suffix as a list of string:
61#
62# source_suffix = ['.rst', '.md']
63source_suffix = ['.rst', '.md', '.txt']
64
65# The master toctree document.
66master_doc = 'index'
67
68# The language for content autogenerated by Sphinx. Refer to documentation
69# for a list of supported languages.
70#
71# This is also used if you do content translation via gettext catalogs.
72# Usually you set "language" from the command line for these cases.
73language = None
74
75# List of patterns, relative to source directory, that match files and
76# directories to ignore when looking for source files.
77# This pattern also affects html_static_path and html_extra_path .
78exclude_patterns = []
79
80# The name of the Pygments (syntax highlighting) style to use.
81pygments_style = 'sphinx'
82
83
84# -- Options for HTML output -------------------------------------------------
85
86# The theme to use for HTML and HTML Help pages.  See the documentation for
87# a list of builtin themes.
88#
89html_theme = 'sphinx_rtd_theme'
90
91# Theme options are theme-specific and customize the look and feel of a theme
92# further.  For a list of options available for each theme, see the
93# documentation.
94#
95# html_theme_options = {}
96
97# Add any paths that contain custom static files (such as style sheets) here,
98# relative to this directory. They are copied after the builtin static files,
99# so a file named "default.css" will overwrite the builtin "default.css".
100html_static_path = ['_static']
101
102# Custom sidebar templates, must be a dictionary that maps document names
103# to template names.
104#
105# The default sidebars (for documents that don't match any pattern) are
106# defined by theme itself.  Builtin themes are using these templates by
107# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
108# 'searchbox.html']``.
109#
110# html_sidebars = {}
111
112
113# -- Options for HTMLHelp output ---------------------------------------------
114
115# Output file base name for HTML help builder.
116htmlhelp_basename = 'flex_extractdoc'
117
118
119# -- Options for LaTeX output ------------------------------------------------
120
121latex_elements = {
122    # The paper size ('letterpaper' or 'a4paper').
123    #
124    # 'papersize': 'letterpaper',
125
126    # The font size ('10pt', '11pt' or '12pt').
127    #
128    # 'pointsize': '10pt',
129
130    # Additional stuff for the LaTeX preamble.
131    #
132    # 'preamble': '',
133
134    # Latex figure (float) alignment
135    #
136    # 'figure_align': 'htbp',
137}
138
139# Grouping the document tree into LaTeX files. List of tuples
140# (source start file, target name, title,
141#  author, documentclass [howto, manual, or own class]).
142latex_documents = [
143    (master_doc, 'flex_extract.tex', u'flex\\_extract Documentation',
144     u'Anne Philipp and Leopold Haimberger', 'manual'),
145]
146
147
148# -- Options for manual page output ------------------------------------------
149
150# One entry per manual page. List of tuples
151# (source start file, name, description, authors, manual section).
152man_pages = [
153    (master_doc, 'flex_extract', u'flex_extract Documentation',
154     [author], 1)
155]
156
157
158# -- Options for Texinfo output ----------------------------------------------
159
160# Grouping the document tree into Texinfo files. List of tuples
161# (source start file, target name, title, author,
162#  dir menu entry, description, category)
163texinfo_documents = [
164    (master_doc, 'flex_extract', u'flex_extract Documentation',
165     author, 'flex_extract', 'One line description of project.',
166     'Miscellaneous'),
167]
168
169
170# -- Extension configuration -------------------------------------------------
171
172# -- Options for todo extension ----------------------------------------------
173
174# If true, `todo` and `todoList` produce output, else they produce nothing.
175todo_include_todos = True
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG