Statistics
| Branch: | Tag: | Revision:

root / docs / source / conf.py @ 619b9d16

History | View | Annotate | Download (6 kB)

1
# -*- coding: utf-8 -*-
2
#
3
# DjNRO (eduroam) documentation build configuration file
4
#
5
# This file is execfile()d with the current directory set to its containing dir.
6
#
7
# Note that not all possible configuration values are present in this
8
# autogenerated file.
9
#
10
# All configuration values have a default; values that are commented out
11
# serve to show the default.
12

    
13
import sys, os
14

    
15

    
16
# Optional. Use a shorter name to conserve nav. bar space.
17

    
18
# If extensions (or modules to document with autodoc) are in another directory,
19
# add these directories to sys.path here. If the directory is relative to the
20
# documentation root, use os.path.abspath to make it absolute, like shown here.
21

    
22

    
23
# -- General configuration -----------------------------------------------------
24

    
25
# If your documentation needs a minimal Sphinx version, state it here.
26
#needs_sphinx = "1.0"
27

    
28
# Add any Sphinx extension module names here, as strings. They can be extensions
29
# coming with Sphinx (named "sphinx.ext.*") or your custom ones.
30
extensions = [
31
  "sphinx.ext.todo",
32
  "sphinx.ext.graphviz",
33
  'sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig', 'sphinx.ext.autosummary'
34
  ]
35

    
36
# Add any paths that contain templates here, relative to this directory.
37
#templates_path = ["_templates"]
38

    
39
# The suffix of source filenames.
40
source_suffix = ".rst"
41

    
42
# The encoding of source files.
43
source_encoding = "utf-8"
44

    
45
# The master toctree document.
46
master_doc = "index"
47

    
48
# General information about the project.
49
project = u"DjNRO"
50
copyright = u"2014, GRNET S.A. - Designed and developed by Leonidas Poulopoulos, Zenon Mousmoulas and Stavros Kroustouris - GRNET NOC"
51

    
52
# The version info for the project you're documenting, acts as replacement for
53
# |version| and |release|, also used in various other places throughout the
54
# built documents.
55
#
56
# These next two will be passed via the command line, see the makefile
57
# The short X.Y version
58
version = "0.9"
59
# The full version, including alpha/beta/rc tags.
60
release = "0.9.1"
61

    
62
# The language for content autogenerated by Sphinx. Refer to documentation
63
# for a list of supported languages.
64
language = "en"
65

    
66
# There are two options for replacing |today|: either, you set today to some
67
# non-false value, then it is used:
68
#today = ""
69
# Else, today_fmt is used as the format for a strftime call.
70
#today_fmt = "%B %d, %Y"
71

    
72
# List of documents that shouldn't be included in the build.
73
#unused_docs = []
74

    
75
# List of directories, relative to source directory, that shouldn't be searched
76
# for source files.
77
#exclude_trees = [
78
 # "_build",
79
 # "api",
80
 # ]
81

    
82
# The reST default role (used for this markup: `text`) to use for all documents.
83
#default_role = None
84

    
85
# If true, "()" will be appended to :func: etc. cross-reference text.
86
#add_function_parentheses = True
87

    
88
# If true, the current module name will be prepended to all description
89
# unit titles (such as .. function::).
90
#add_module_names = True
91

    
92
# If true, sectionauthor and moduleauthor directives will be shown in the
93
# output. They are ignored by default.
94
#show_authors = False
95

    
96
# The name of the Pygments (syntax highlighting) style to use.
97
pygments_style = "sphinx"
98

    
99
# A list of ignored prefixes for module index sorting.
100
#modindex_common_prefix = ['iooclient.']
101

    
102

    
103
# -- Options for HTML output ---------------------------------------------------
104

    
105
# The theme to use for HTML and HTML Help pages.  See the documentation for
106
# a list of builtin themes.
107
#html_theme = "sphinxdoc"
108

    
109
# Theme options are theme-specific and customize the look and feel of a theme
110
# further.  For a list of options available for each theme, see the
111
# documentation.
112
#html_theme_options = {}
113

    
114
# Add any paths that contain custom themes here, relative to this directory.
115
#html_theme_path = []
116

    
117
# The name for this set of Sphinx documents.  If None, it defaults to
118
# "<project> v<release> documentation".
119
#html_title = None
120

    
121
# A shorter title for the navigation bar.  Default is the same as html_title.
122
#html_short_title = None
123

    
124
# The name of an image file (relative to this directory) to place at the top
125
# of the sidebar.
126
html_logo = "logo.png"
127

    
128
# The name of an image file (within the static path) to use as favicon of the
129
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
130
# pixels large.
131
#html_favicon = None
132

    
133
# Add any paths that contain custom static files (such as style sheets) here,
134
# relative to this directory. They are copied after the builtin static files,
135
# so a file named "default.css" will overwrite the builtin "default.css".
136
html_static_path = ['_static']
137

    
138
# If not "", a "Last updated on:" timestamp is inserted at every page bottom,
139
# using the given strftime format.
140
#html_last_updated_fmt = "%b %d, %Y"
141

    
142
# If true, SmartyPants will be used to convert quotes and dashes to
143
# typographically correct entities.
144
#html_use_smartypants = True
145

    
146
# Custom sidebar templates, maps document names to template names.
147
#html_sidebars = {}
148

    
149
# Additional templates that should be rendered to pages, maps page names to
150
# template names.
151
#html_additional_pages = {}
152

    
153
# If false, no module index is generated.
154
html_use_modindex = False
155

    
156
# If false, no index is generated.
157
html_use_index = False
158

    
159
# If true, the index is split into individual pages for each letter.
160
#html_split_index = False
161

    
162
# If true, links to the reST sources are added to the pages.
163
#html_show_sourcelink = True
164

    
165
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
166
#html_show_sphinx = True
167

    
168
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
169
#html_show_copyright = True
170

    
171
# If true, an OpenSearch description file will be output, and all pages will
172
# contain a <link> tag referring to it.  The value of this option must be the
173
# base URL from which the finished HTML is served.
174
#html_use_opensearch = ""
175

    
176
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
177
#html_file_suffix = ""
178

    
179
# Output file base name for HTML help builder.
180
htmlhelp_basename = "eduroamdoc"
181

    
182
intersphinx_mapping = {'http://docs.python.org/': None}
183

    
184
autoclass_content = 'both'