Statistics
| Branch: | Tag: | Revision:

root / docs / source / conf.py @ bbd4ce54

History | View | Annotate | Download (6.4 kB)

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

    
10
import sys, os
11

    
12
# If extensions (or modules to document with autodoc) are in another directory,
13
# add these directories to sys.path here. If the directory is relative to the
14
# documentation root, use os.path.abspath to make it absolute, like shown here.
15
#sys.path.append(os.path.abspath('.'))
16

    
17
# -- General configuration -----------------------------------------------------
18

    
19
# Add any Sphinx extension module names here, as strings. They can be extensions
20
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
21
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage',
22
        'sphinx.ext.graphviz', 'sphinx.ext.inheritance_diagram']
23

    
24
# Add any paths that contain templates here, relative to this directory.
25
templates_path = ['_templates']
26

    
27
# The suffix of source filenames.
28
source_suffix = '.rst'
29

    
30
# The encoding of source files.
31
#source_encoding = 'utf-8'
32

    
33
# The master toctree document.
34
master_doc = 'index'
35

    
36
# General information about the project.
37
project = u'ncclient'
38
copyright = u'2009, Shikhar Bhushan'
39
license = 'APL'
40

    
41
# The version info for the project you're documenting, acts as replacement for
42
# |version| and |release|, also used in various other places throughout the
43
# built documents.
44
#
45
# The short X.Y version.
46
version = '0.1'
47
# The full version, including alpha/beta/rc tags.
48
release = '0.1.0'
49

    
50
# The language for content autogenerated by Sphinx. Refer to documentation
51
# for a list of supported languages.
52
#language = None
53

    
54
# There are two options for replacing |today|: either, you set today to some
55
# non-false value, then it is used:
56
#today = ''
57
# Else, today_fmt is used as the format for a strftime call.
58
#today_fmt = '%B %d, %Y'
59

    
60
# List of documents that shouldn't be included in the build.
61
#unused_docs = []
62

    
63
# List of directories, relative to source directory, that shouldn't be searched
64
# for source files.
65
exclude_trees = []
66

    
67
# The reST default role (used for this markup: `text`) to use for all documents.
68
default_role = 'obj' 
69

    
70
# If true, '()' will be appended to :func: etc. cross-reference text.
71
#add_function_parentheses = True
72

    
73
# If true, the current module name will be prepended to all description
74
# unit titles (such as .. function::).
75
#add_module_names = True
76

    
77
# If true, sectionauthor and moduleauthor directives will be shown in the
78
# output. They are ignored by default.
79
#show_authors = False
80

    
81
# The name of the Pygments (syntax highlighting) style to use.
82
pygments_style = 'sphinx'
83

    
84
# A list of ignored prefixes for module index sorting.
85
modindex_common_prefix = ['ncclient.']
86

    
87

    
88
# -- Options for HTML output ---------------------------------------------------
89

    
90
# The theme to use for HTML and HTML Help pages.  Major themes that come with
91
# Sphinx are currently 'default' and 'sphinxdoc'.
92
html_theme = 'default'
93

    
94
# Theme options are theme-specific and customize the look and feel of a theme
95
# further.  For a list of options available for each theme, see the
96
# documentation.
97
#html_theme_options = {}
98

    
99
# Add any paths that contain custom themes here, relative to this directory.
100
#html_theme_path = []
101

    
102
# The name for this set of Sphinx documents.  If None, it defaults to
103
# "<project> v<release> documentation".
104
#html_title = None
105

    
106
# A shorter title for the navigation bar.  Default is the same as html_title.
107
#html_short_title = None
108

    
109
# The name of an image file (relative to this directory) to place at the top
110
# of the sidebar.
111
#html_logo = None
112

    
113
# The name of an image file (within the static path) to use as favicon of the
114
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
115
# pixels large.
116
#html_favicon = None
117

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

    
123
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
124
# using the given strftime format.
125
#html_last_updated_fmt = '%b %d, %Y'
126

    
127
# If true, SmartyPants will be used to convert quotes and dashes to
128
# typographically correct entities.
129
#html_use_smartypants = True
130

    
131
# Custom sidebar templates, maps document names to template names.
132
#html_sidebars = {}
133

    
134
# Additional templates that should be rendered to pages, maps page names to
135
# template names.
136
#html_additional_pages = {}
137

    
138
# If false, no module index is generated.
139
#html_use_modindex = True
140

    
141
# If false, no index is generated.
142
#html_use_index = True
143

    
144
# If true, the index is split into individual pages for each letter.
145
#html_split_index = False
146

    
147
# If true, links to the reST sources are added to the pages.
148
#html_show_sourcelink = True
149

    
150
# If true, an OpenSearch description file will be output, and all pages will
151
# contain a <link> tag referring to it.  The value of this option must be the
152
# base URL from which the finished HTML is served.
153
#html_use_opensearch = ''
154

    
155
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
156
#html_file_suffix = ''
157

    
158
# Output file base name for HTML help builder.
159
htmlhelp_basename = 'ncclientdoc'
160

    
161

    
162
# -- Options for LaTeX output --------------------------------------------------
163

    
164
# The paper size ('letter' or 'a4').
165
latex_paper_size = 'a4'
166

    
167
# The font size ('10pt', '11pt' or '12pt').
168
#latex_font_size = '10pt'
169

    
170
# Grouping the document tree into LaTeX files. List of tuples
171
# (source start file, target name, title, author, documentclass [howto/manual]).
172
latex_documents = [
173
  ('index', 'ncclient.tex', u'NCClient Documentation',
174
   u'Shikhar Bhushan', 'manual', True),
175
  ]
176

    
177
# The name of an image file (relative to this directory) to place at the top of
178
# the title page.
179
#latex_logo = None
180

    
181
# For "manual" documents, if this is true, then toplevel headings are parts,
182
# not chapters.
183
#latex_use_parts = True
184

    
185
# Additional stuff for the LaTeX preamble.
186
latex_preamble = ''
187

    
188
# Documents to append as an appendix to all manuals.
189
#latex_appendices = []
190

    
191
# If false, no module index is generated.
192
#latex_use_modindex = True
193

    
194

    
195
# Example configuration for intersphinx: refer to the Python standard library.
196
intersphinx_mapping = {'http://docs.python.org/': None}