« back to all changes in this revision
Viewing changes to doc/conf.py
- browse files at revision 1
- compare with another revision
- compare with revision 1
- download diff
- download tarball
- view history from revision 1
- Committer: Stephan Peijnik
- Date: 2010-04-23 18:10:11 UTC
- Revision ID: debian@sp.or.at-20100423181011-u1uo3ui7do6qw7gm
Initial import from HG tree.
- files added:
- doc
- doc/_build
- doc/_static
- doc/_templates
added
removed
doc/conf.py
1
# -*- coding: utf-8 -*-
2
#
3
# argvalidate - Python argument validator library documentation build configuration file, created by
4
# sphinx-quickstart on Wed Feb 25 09:15:17 2009.
5
#
6
# This file is execfile()d with the current directory set to its containing dir.
7
#
8
# The contents of this file are pickled, so don't put values in the namespace
9
# that aren't pickleable (module imports are okay, they're removed automatically).
10
#
11
# All configuration values have a default value; values that are commented out
12
# serve to show the default value.
13
14
import sys
15
import os
16
17
file_abspath = os.path.dirname(os.path.abspath(__file__))
18
parent_path = os.path.abspath(os.path.join(file_abspath, '..'))
19
sys.path.insert(0, parent_path)
20
21
# If your extensions are in another directory, add it here. If the directory
22
# is relative to the documentation root, use os.path.abspath to make it
23
# absolute, like shown here.
24
#sys.path.append(os.path.abspath('some/directory'))
25
26
# General configuration
27
# ---------------------
28
29
# Add any Sphinx extension module names here, as strings. They can be extensions
30
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
31
extensions = ['sphinx.ext.autodoc']
32
33
# Add any paths that contain templates here, relative to this directory.
34
templates_path = ['_templates']
35
36
# The suffix of source filenames.
37
source_suffix = '.rst'
38
39
# The master toctree document.
40
master_doc = 'index'
41
42
# General substitutions.
43
project = 'argvalidate - Python argument validator library'
44
copyright = '2009, Stephan Peijnik'
45
46
# The default replacements for |version| and |release|, also used in various
47
# other places throughout the built documents.
48
#
49
# The short X.Y version.
50
51
from argvalidate import __version__
52
53
version = __version__
54
# The full version, including alpha/beta/rc tags.
55
release = version
56
57
# There are two options for replacing |today|: either, you set today to some
58
# non-false value, then it is used:
59
#today = ''
60
# Else, today_fmt is used as the format for a strftime call.
61
today_fmt = '%B %d, %Y'
62
63
# List of documents that shouldn't be included in the build.
64
#unused_docs = []
65
66
# List of directories, relative to source directories, that shouldn't be searched
67
# for source files.
68
#exclude_dirs = []
69
70
# The reST default role (used for this markup: `text`) to use for all documents.
71
#default_role = None
72
73
# If true, '()' will be appended to :func: etc. cross-reference text.
74
#add_function_parentheses = True
75
76
# If true, the current module name will be prepended to all description
77
# unit titles (such as .. function::).
78
#add_module_names = True
79
80
# If true, sectionauthor and moduleauthor directives will be shown in the
81
# output. They are ignored by default.
82
#show_authors = False
83
84
# The name of the Pygments (syntax highlighting) style to use.
85
pygments_style = 'sphinx'
86
87
88
# Options for HTML output
89
# -----------------------
90
91
# The style sheet to use for HTML and HTML Help pages. A file of that name
92
# must exist either in Sphinx' static/ path, or in one of the custom paths
93
# given in html_static_path.
94
html_style = 'default.css'
95
96
# The name for this set of Sphinx documents. If None, it defaults to
97
# "<project> v<release> documentation".
98
#html_title = None
99
100
# A shorter title for the navigation bar. Default is the same as html_title.
101
#html_short_title = None
102
103
# The name of an image file (within the static path) to place at the top of
104
# the sidebar.
105
#html_logo = None
106
107
# The name of an image file (within the static path) to use as favicon of the
108
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
109
# pixels large.
110
#html_favicon = None
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".
115
html_static_path = ['_static']
116
117
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
118
# using the given strftime format.
119
html_last_updated_fmt = '%b %d, %Y'
120
121
# If true, SmartyPants will be used to convert quotes and dashes to
122
# typographically correct entities.
123
#html_use_smartypants = True
124
125
# Custom sidebar templates, maps document names to template names.
126
#html_sidebars = {}
127
128
# Additional templates that should be rendered to pages, maps page names to
129
# template names.
130
#html_additional_pages = {}
131
132
# If false, no module index is generated.
133
#html_use_modindex = True
134
135
# If false, no index is generated.
136
#html_use_index = True
137
138
# If true, the index is split into individual pages for each letter.
139
#html_split_index = False
140
141
# If true, the reST sources are included in the HTML build as _sources/<name>.
142
#html_copy_source = True
143
144
# If true, an OpenSearch description file will be output, and all pages will
145
# contain a <link> tag referring to it. The value of this option must be the
146
# base URL from which the finished HTML is served.
147
#html_use_opensearch = ''
148
149
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
150
#html_file_suffix = ''
151
152
# Output file base name for HTML help builder.
153
htmlhelp_basename = 'argvalidate-Pythonargumentvalidatorlibrarydoc'
154
155
156
# Options for LaTeX output
157
# ------------------------
158
159
# The paper size ('letter' or 'a4').
160
#latex_paper_size = 'letter'
161
162
# The font size ('10pt', '11pt' or '12pt').
163
#latex_font_size = '10pt'
164
165
# Grouping the document tree into LaTeX files. List of tuples
166
# (source start file, target name, title, author, document class [howto/manual]).
167
latex_documents = [
168
('index', 'argvalidate-Pythonargumentvalidatorlibrary.tex', 'argvalidate - Python argument validator library Documentation',
169
'Stephan Peijnik', 'manual'),
170
]
171
172
# The name of an image file (relative to this directory) to place at the top of
173
# the title page.
174
#latex_logo = None
175
176
# For "manual" documents, if this is true, then toplevel headings are parts,
177
# not chapters.
178
#latex_use_parts = False
179
180
# Additional stuff for the LaTeX preamble.
181
#latex_preamble = ''
182
183
# Documents to append as an appendix to all manuals.
184
#latex_appendices = []
185
186
# If false, no module index is generated.
187
#latex_use_modindex = True
Loggerhead is a web-based interface for Breezy
Version: 2.0.1