2 # -*- coding: utf-8 -*-
4 # uccvend-vendserver documentation build configuration file, created by
5 # sphinx-quickstart on Tue Jul 9 22:26:36 2013.
7 # This file is execfile()d with the current directory set to its
10 # Note that not all possible configuration values are present in this
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
19 # If extensions (or modules to document with autodoc) are in another
20 # directory, add these directories to sys.path here. If the directory is
21 # relative to the documentation root, use os.path.abspath to make it
22 # absolute, like shown here.
23 #sys.path.insert(0, os.path.abspath('.'))
25 # Get the project root dir, which is the parent dir of this
27 project_root = os.path.dirname(cwd)
29 # Insert the project root dir as the first element in the PYTHONPATH.
30 # This lets us ensure that the source package is imported, and that its
32 sys.path.insert(0, project_root)
34 import uccvend-vendserver
36 # -- General configuration ---------------------------------------------
38 # If your documentation needs a minimal Sphinx version, state it here.
41 # Add any Sphinx extension module names here, as strings. They can be
42 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
43 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
45 # Add any paths that contain templates here, relative to this directory.
46 templates_path = ['_templates']
48 # The suffix of source filenames.
49 source_suffix = '.rst'
51 # The encoding of source files.
52 #source_encoding = 'utf-8-sig'
54 # The master toctree document.
57 # General information about the project.
58 project = u'UCC Vendserver'
59 copyright = u'2014, ACC Murphy'
61 # The version info for the project you're documenting, acts as replacement
62 # for |version| and |release|, also used in various other places throughout
63 # the built documents.
65 # The short X.Y version.
66 version = uccvend-vendserver.__version__
67 # The full version, including alpha/beta/rc tags.
68 release = uccvend-vendserver.__version__
70 # The language for content autogenerated by Sphinx. Refer to documentation
71 # for a list of supported languages.
74 # There are two options for replacing |today|: either, you set today to
75 # some non-false value, then it is used:
77 # Else, today_fmt is used as the format for a strftime call.
78 #today_fmt = '%B %d, %Y'
80 # List of patterns, relative to source directory, that match files and
81 # directories to ignore when looking for source files.
82 exclude_patterns = ['_build']
84 # The reST default role (used for this markup: `text`) to use for all
88 # If true, '()' will be appended to :func: etc. cross-reference text.
89 #add_function_parentheses = True
91 # If true, the current module name will be prepended to all description
92 # unit titles (such as .. function::).
93 #add_module_names = True
95 # If true, sectionauthor and moduleauthor directives will be shown in the
96 # output. They are ignored by default.
99 # The name of the Pygments (syntax highlighting) style to use.
100 pygments_style = 'sphinx'
102 # A list of ignored prefixes for module index sorting.
103 #modindex_common_prefix = []
105 # If true, keep warnings as "system message" paragraphs in the built
107 #keep_warnings = False
110 # -- Options for HTML output -------------------------------------------
112 # The theme to use for HTML and HTML Help pages. See the documentation for
113 # a list of builtin themes.
114 html_theme = 'default'
116 # Theme options are theme-specific and customize the look and feel of a
117 # theme further. For a list of options available for each theme, see the
119 #html_theme_options = {}
121 # Add any paths that contain custom themes here, relative to this directory.
122 #html_theme_path = []
124 # The name for this set of Sphinx documents. If None, it defaults to
125 # "<project> v<release> documentation".
128 # A shorter title for the navigation bar. Default is the same as
130 #html_short_title = None
132 # The name of an image file (relative to this directory) to place at the
133 # top of the sidebar.
136 # The name of an image file (within the static path) to use as favicon
137 # of the docs. This file should be a Windows icon file (.ico) being
138 # 16x16 or 32x32 pixels large.
141 # Add any paths that contain custom static files (such as style sheets)
142 # here, relative to this directory. They are copied after the builtin
143 # static files, so a file named "default.css" will overwrite the builtin
145 html_static_path = ['_static']
147 # If not '', a 'Last updated on:' timestamp is inserted at every page
148 # bottom, using the given strftime format.
149 #html_last_updated_fmt = '%b %d, %Y'
151 # If true, SmartyPants will be used to convert quotes and dashes to
152 # typographically correct entities.
153 #html_use_smartypants = True
155 # Custom sidebar templates, maps document names to template names.
158 # Additional templates that should be rendered to pages, maps page names
160 #html_additional_pages = {}
162 # If false, no module index is generated.
163 #html_domain_indices = True
165 # If false, no index is generated.
166 #html_use_index = True
168 # If true, the index is split into individual pages for each letter.
169 #html_split_index = False
171 # If true, links to the reST sources are added to the pages.
172 #html_show_sourcelink = True
174 # If true, "Created using Sphinx" is shown in the HTML footer.
176 #html_show_sphinx = True
178 # If true, "(C) Copyright ..." is shown in the HTML footer.
180 #html_show_copyright = True
182 # If true, an OpenSearch description file will be output, and all pages
183 # will contain a <link> tag referring to it. The value of this option
184 # must be the base URL from which the finished HTML is served.
185 #html_use_opensearch = ''
187 # This is the file name suffix for HTML files (e.g. ".xhtml").
188 #html_file_suffix = None
190 # Output file base name for HTML help builder.
191 htmlhelp_basename = 'uccvend-vendserverdoc'
194 # -- Options for LaTeX output ------------------------------------------
197 # The paper size ('letterpaper' or 'a4paper').
198 #'papersize': 'letterpaper',
200 # The font size ('10pt', '11pt' or '12pt').
201 #'pointsize': '10pt',
203 # Additional stuff for the LaTeX preamble.
207 # Grouping the document tree into LaTeX files. List of tuples
208 # (source start file, target name, title, author, documentclass
211 ('index', 'uccvend-vendserver.tex',
212 u'UCC Vendserver Documentation',
213 u'ACC Murphy', 'manual'),
216 # The name of an image file (relative to this directory) to place at
217 # the top of the title page.
220 # For "manual" documents, if this is true, then toplevel headings
221 # are parts, not chapters.
222 #latex_use_parts = False
224 # If true, show page references after internal links.
225 #latex_show_pagerefs = False
227 # If true, show URL addresses after external links.
228 #latex_show_urls = False
230 # Documents to append as an appendix to all manuals.
231 #latex_appendices = []
233 # If false, no module index is generated.
234 #latex_domain_indices = True
237 # -- Options for manual page output ------------------------------------
239 # One entry per manual page. List of tuples
240 # (source start file, name, description, authors, manual section).
242 ('index', 'uccvend-vendserver',
243 u'UCC Vendserver Documentation',
247 # If true, show URL addresses after external links.
248 #man_show_urls = False
251 # -- Options for Texinfo output ----------------------------------------
253 # Grouping the document tree into Texinfo files. List of tuples
254 # (source start file, target name, title, author,
255 # dir menu entry, description, category)
256 texinfo_documents = [
257 ('index', 'uccvend-vendserver',
258 u'UCC Vendserver Documentation',
260 'uccvend-vendserver',
261 'One line description of project.',
265 # Documents to append as an appendix to all manuals.
266 #texinfo_appendices = []
268 # If false, no module index is generated.
269 #texinfo_domain_indices = True
271 # How to display URL addresses: 'footnote', 'no', or 'inline'.
272 #texinfo_show_urls = 'footnote'
274 # If true, do not generate a @detailmenu in the "Top" node's menu.
275 #texinfo_no_detailmenu = False