root / docs / source / conf.py @ 09e50473
History | View | Annotate | Download (6.5 kB)
1 | 39ce7446 | Shikhar Bhushan | # -*- coding: utf-8 -*-
|
---|---|---|---|
2 | 39ce7446 | Shikhar Bhushan | #
|
3 | 39ce7446 | Shikhar Bhushan | # ncclient documentation build configuration file, created by
|
4 | 39ce7446 | Shikhar Bhushan | # sphinx-quickstart on Fri Sep 18 17:32:15 2009.
|
5 | 39ce7446 | Shikhar Bhushan | #
|
6 | 39ce7446 | Shikhar Bhushan | # This file is execfile()d with the current directory set to its containing dir.
|
7 | 39ce7446 | Shikhar Bhushan | #
|
8 | 39ce7446 | Shikhar Bhushan | # Note that not all possible configuration values are present in this
|
9 | 39ce7446 | Shikhar Bhushan | # autogenerated file.
|
10 | 39ce7446 | Shikhar Bhushan | #
|
11 | 39ce7446 | Shikhar Bhushan | # All configuration values have a default; values that are commented out
|
12 | 39ce7446 | Shikhar Bhushan | # serve to show the default.
|
13 | 39ce7446 | Shikhar Bhushan | |
14 | 39ce7446 | Shikhar Bhushan | import sys, os |
15 | 39ce7446 | Shikhar Bhushan | |
16 | 39ce7446 | Shikhar Bhushan | # If extensions (or modules to document with autodoc) are in another directory,
|
17 | 39ce7446 | Shikhar Bhushan | # add these directories to sys.path here. If the directory is relative to the
|
18 | 39ce7446 | Shikhar Bhushan | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
19 | 39ce7446 | Shikhar Bhushan | #sys.path.append(os.path.abspath('.'))
|
20 | 39ce7446 | Shikhar Bhushan | |
21 | 39ce7446 | Shikhar Bhushan | # -- General configuration -----------------------------------------------------
|
22 | 39ce7446 | Shikhar Bhushan | |
23 | 39ce7446 | Shikhar Bhushan | # Add any Sphinx extension module names here, as strings. They can be extensions
|
24 | 39ce7446 | Shikhar Bhushan | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
25 | 39ce7446 | Shikhar Bhushan | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig'] |
26 | 39ce7446 | Shikhar Bhushan | |
27 | 39ce7446 | Shikhar Bhushan | # Add any paths that contain templates here, relative to this directory.
|
28 | 39ce7446 | Shikhar Bhushan | templates_path = ['_templates']
|
29 | 39ce7446 | Shikhar Bhushan | |
30 | 39ce7446 | Shikhar Bhushan | # The suffix of source filenames.
|
31 | 39ce7446 | Shikhar Bhushan | source_suffix = '.rst'
|
32 | 39ce7446 | Shikhar Bhushan | |
33 | 39ce7446 | Shikhar Bhushan | # The encoding of source files.
|
34 | 39ce7446 | Shikhar Bhushan | #source_encoding = 'utf-8'
|
35 | 39ce7446 | Shikhar Bhushan | |
36 | 39ce7446 | Shikhar Bhushan | # The master toctree document.
|
37 | 39ce7446 | Shikhar Bhushan | master_doc = 'index'
|
38 | 39ce7446 | Shikhar Bhushan | |
39 | 39ce7446 | Shikhar Bhushan | # General information about the project.
|
40 | 39ce7446 | Shikhar Bhushan | project = u'ncclient'
|
41 | 39ce7446 | Shikhar Bhushan | copyright = u'2009, Shikhar Bhushan'
|
42 | 39ce7446 | Shikhar Bhushan | |
43 | 39ce7446 | Shikhar Bhushan | # The version info for the project you're documenting, acts as replacement for
|
44 | 39ce7446 | Shikhar Bhushan | # |version| and |release|, also used in various other places throughout the
|
45 | 39ce7446 | Shikhar Bhushan | # built documents.
|
46 | 39ce7446 | Shikhar Bhushan | #
|
47 | 39ce7446 | Shikhar Bhushan | # The short X.Y version.
|
48 | 39ce7446 | Shikhar Bhushan | version = '0.2'
|
49 | 39ce7446 | Shikhar Bhushan | # The full version, including alpha/beta/rc tags.
|
50 | 39ce7446 | Shikhar Bhushan | release = '0.2a'
|
51 | 39ce7446 | Shikhar Bhushan | |
52 | 39ce7446 | Shikhar Bhushan | # The language for content autogenerated by Sphinx. Refer to documentation
|
53 | 39ce7446 | Shikhar Bhushan | # for a list of supported languages.
|
54 | 39ce7446 | Shikhar Bhushan | #language = None
|
55 | 39ce7446 | Shikhar Bhushan | |
56 | 39ce7446 | Shikhar Bhushan | # There are two options for replacing |today|: either, you set today to some
|
57 | 39ce7446 | Shikhar Bhushan | # non-false value, then it is used:
|
58 | 39ce7446 | Shikhar Bhushan | #today = ''
|
59 | 39ce7446 | Shikhar Bhushan | # Else, today_fmt is used as the format for a strftime call.
|
60 | 39ce7446 | Shikhar Bhushan | #today_fmt = '%B %d, %Y'
|
61 | 39ce7446 | Shikhar Bhushan | |
62 | 39ce7446 | Shikhar Bhushan | # List of documents that shouldn't be included in the build.
|
63 | 39ce7446 | Shikhar Bhushan | #unused_docs = []
|
64 | 39ce7446 | Shikhar Bhushan | |
65 | 39ce7446 | Shikhar Bhushan | # List of directories, relative to source directory, that shouldn't be searched
|
66 | 39ce7446 | Shikhar Bhushan | # for source files.
|
67 | 39ce7446 | Shikhar Bhushan | exclude_trees = [] |
68 | 39ce7446 | Shikhar Bhushan | |
69 | 39ce7446 | Shikhar Bhushan | # The reST default role (used for this markup: `text`) to use for all documents.
|
70 | 09e50473 | Shikhar Bhushan | default_role = 'class'
|
71 | 39ce7446 | Shikhar Bhushan | |
72 | 39ce7446 | Shikhar Bhushan | # If true, '()' will be appended to :func: etc. cross-reference text.
|
73 | 39ce7446 | Shikhar Bhushan | #add_function_parentheses = True
|
74 | 39ce7446 | Shikhar Bhushan | |
75 | 39ce7446 | Shikhar Bhushan | # If true, the current module name will be prepended to all description
|
76 | 39ce7446 | Shikhar Bhushan | # unit titles (such as .. function::).
|
77 | 39ce7446 | Shikhar Bhushan | #add_module_names = True
|
78 | 39ce7446 | Shikhar Bhushan | |
79 | 39ce7446 | Shikhar Bhushan | # If true, sectionauthor and moduleauthor directives will be shown in the
|
80 | 39ce7446 | Shikhar Bhushan | # output. They are ignored by default.
|
81 | 39ce7446 | Shikhar Bhushan | #show_authors = False
|
82 | 39ce7446 | Shikhar Bhushan | |
83 | 39ce7446 | Shikhar Bhushan | # The name of the Pygments (syntax highlighting) style to use.
|
84 | 39ce7446 | Shikhar Bhushan | pygments_style = 'sphinx'
|
85 | 39ce7446 | Shikhar Bhushan | |
86 | 39ce7446 | Shikhar Bhushan | # A list of ignored prefixes for module index sorting.
|
87 | 39ce7446 | Shikhar Bhushan | modindex_common_prefix = ["ncclient."]
|
88 | 39ce7446 | Shikhar Bhushan | |
89 | 39ce7446 | Shikhar Bhushan | |
90 | 39ce7446 | Shikhar Bhushan | # -- Options for HTML output ---------------------------------------------------
|
91 | 39ce7446 | Shikhar Bhushan | |
92 | 39ce7446 | Shikhar Bhushan | # The theme to use for HTML and HTML Help pages. Major themes that come with
|
93 | 39ce7446 | Shikhar Bhushan | # Sphinx are currently 'default' and 'sphinxdoc'.
|
94 | 39ce7446 | Shikhar Bhushan | html_theme = 'default'
|
95 | 39ce7446 | Shikhar Bhushan | |
96 | 39ce7446 | Shikhar Bhushan | # Theme options are theme-specific and customize the look and feel of a theme
|
97 | 39ce7446 | Shikhar Bhushan | # further. For a list of options available for each theme, see the
|
98 | 39ce7446 | Shikhar Bhushan | # documentation.
|
99 | 39ce7446 | Shikhar Bhushan | #html_theme_options = {}
|
100 | 39ce7446 | Shikhar Bhushan | |
101 | 39ce7446 | Shikhar Bhushan | # Add any paths that contain custom themes here, relative to this directory.
|
102 | 39ce7446 | Shikhar Bhushan | #html_theme_path = []
|
103 | 39ce7446 | Shikhar Bhushan | |
104 | 39ce7446 | Shikhar Bhushan | # The name for this set of Sphinx documents. If None, it defaults to
|
105 | 39ce7446 | Shikhar Bhushan | # "<project> v<release> documentation".
|
106 | 39ce7446 | Shikhar Bhushan | #html_title = None
|
107 | 39ce7446 | Shikhar Bhushan | |
108 | 39ce7446 | Shikhar Bhushan | # A shorter title for the navigation bar. Default is the same as html_title.
|
109 | 39ce7446 | Shikhar Bhushan | #html_short_title = None
|
110 | 39ce7446 | Shikhar Bhushan | |
111 | 39ce7446 | Shikhar Bhushan | # The name of an image file (relative to this directory) to place at the top
|
112 | 39ce7446 | Shikhar Bhushan | # of the sidebar.
|
113 | 39ce7446 | Shikhar Bhushan | html_logo = "_static/logo.png"
|
114 | 39ce7446 | Shikhar Bhushan | |
115 | 39ce7446 | Shikhar Bhushan | # The name of an image file (within the static path) to use as favicon of the
|
116 | 39ce7446 | Shikhar Bhushan | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
117 | 39ce7446 | Shikhar Bhushan | # pixels large.
|
118 | 39ce7446 | Shikhar Bhushan | #html_favicon = None
|
119 | 39ce7446 | Shikhar Bhushan | |
120 | 39ce7446 | Shikhar Bhushan | # Add any paths that contain custom static files (such as style sheets) here,
|
121 | 39ce7446 | Shikhar Bhushan | # relative to this directory. They are copied after the builtin static files,
|
122 | 39ce7446 | Shikhar Bhushan | # so a file named "default.css" will overwrite the builtin "default.css".
|
123 | 39ce7446 | Shikhar Bhushan | html_static_path = ['_static']
|
124 | 39ce7446 | Shikhar Bhushan | |
125 | 39ce7446 | Shikhar Bhushan | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
126 | 39ce7446 | Shikhar Bhushan | # using the given strftime format.
|
127 | 39ce7446 | Shikhar Bhushan | #html_last_updated_fmt = '%b %d, %Y'
|
128 | 39ce7446 | Shikhar Bhushan | |
129 | 39ce7446 | Shikhar Bhushan | # If true, SmartyPants will be used to convert quotes and dashes to
|
130 | 39ce7446 | Shikhar Bhushan | # typographically correct entities.
|
131 | 39ce7446 | Shikhar Bhushan | #html_use_smartypants = True
|
132 | 39ce7446 | Shikhar Bhushan | |
133 | 39ce7446 | Shikhar Bhushan | # Custom sidebar templates, maps document names to template names.
|
134 | 39ce7446 | Shikhar Bhushan | #html_sidebars = {}
|
135 | 39ce7446 | Shikhar Bhushan | |
136 | 39ce7446 | Shikhar Bhushan | # Additional templates that should be rendered to pages, maps page names to
|
137 | 39ce7446 | Shikhar Bhushan | # template names.
|
138 | 39ce7446 | Shikhar Bhushan | #html_additional_pages = {}
|
139 | 39ce7446 | Shikhar Bhushan | |
140 | 39ce7446 | Shikhar Bhushan | # If false, no module index is generated.
|
141 | 39ce7446 | Shikhar Bhushan | #html_use_modindex = True
|
142 | 39ce7446 | Shikhar Bhushan | |
143 | 39ce7446 | Shikhar Bhushan | # If false, no index is generated.
|
144 | 39ce7446 | Shikhar Bhushan | #html_use_index = True
|
145 | 39ce7446 | Shikhar Bhushan | |
146 | 39ce7446 | Shikhar Bhushan | # If true, the index is split into individual pages for each letter.
|
147 | 39ce7446 | Shikhar Bhushan | #html_split_index = False
|
148 | 39ce7446 | Shikhar Bhushan | |
149 | 39ce7446 | Shikhar Bhushan | # If true, links to the reST sources are added to the pages.
|
150 | 39ce7446 | Shikhar Bhushan | #html_show_sourcelink = True
|
151 | 39ce7446 | Shikhar Bhushan | |
152 | 39ce7446 | Shikhar Bhushan | # If true, an OpenSearch description file will be output, and all pages will
|
153 | 39ce7446 | Shikhar Bhushan | # contain a <link> tag referring to it. The value of this option must be the
|
154 | 39ce7446 | Shikhar Bhushan | # base URL from which the finished HTML is served.
|
155 | 39ce7446 | Shikhar Bhushan | #html_use_opensearch = ''
|
156 | 39ce7446 | Shikhar Bhushan | |
157 | 39ce7446 | Shikhar Bhushan | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
|
158 | 39ce7446 | Shikhar Bhushan | #html_file_suffix = ''
|
159 | 39ce7446 | Shikhar Bhushan | |
160 | 39ce7446 | Shikhar Bhushan | # Output file base name for HTML help builder.
|
161 | 39ce7446 | Shikhar Bhushan | htmlhelp_basename = 'ncclientdoc'
|
162 | 39ce7446 | Shikhar Bhushan | |
163 | 39ce7446 | Shikhar Bhushan | |
164 | 39ce7446 | Shikhar Bhushan | # -- Options for LaTeX output --------------------------------------------------
|
165 | 39ce7446 | Shikhar Bhushan | |
166 | 39ce7446 | Shikhar Bhushan | # The paper size ('letter' or 'a4').
|
167 | 39ce7446 | Shikhar Bhushan | latex_paper_size = 'a4'
|
168 | 39ce7446 | Shikhar Bhushan | |
169 | 39ce7446 | Shikhar Bhushan | # The font size ('10pt', '11pt' or '12pt').
|
170 | 39ce7446 | Shikhar Bhushan | #latex_font_size = '10pt'
|
171 | 39ce7446 | Shikhar Bhushan | |
172 | 39ce7446 | Shikhar Bhushan | # Grouping the document tree into LaTeX files. List of tuples
|
173 | 39ce7446 | Shikhar Bhushan | # (source start file, target name, title, author, documentclass [howto/manual]).
|
174 | 39ce7446 | Shikhar Bhushan | latex_documents = [ |
175 | 39ce7446 | Shikhar Bhushan | ('index', 'ncclient.tex', u'ncclient Documentation', |
176 | 39ce7446 | Shikhar Bhushan | u'Shikhar Bhushan', 'manual'), |
177 | 39ce7446 | Shikhar Bhushan | ] |
178 | 39ce7446 | Shikhar Bhushan | |
179 | 39ce7446 | Shikhar Bhushan | # The name of an image file (relative to this directory) to place at the top of
|
180 | 39ce7446 | Shikhar Bhushan | # the title page.
|
181 | 39ce7446 | Shikhar Bhushan | latex_logo = "_static/logo.png"
|
182 | 39ce7446 | Shikhar Bhushan | |
183 | 39ce7446 | Shikhar Bhushan | # For "manual" documents, if this is true, then toplevel headings are parts,
|
184 | 39ce7446 | Shikhar Bhushan | # not chapters.
|
185 | 39ce7446 | Shikhar Bhushan | #latex_use_parts = False
|
186 | 39ce7446 | Shikhar Bhushan | |
187 | 39ce7446 | Shikhar Bhushan | # Additional stuff for the LaTeX preamble.
|
188 | 39ce7446 | Shikhar Bhushan | #latex_preamble = ''
|
189 | 39ce7446 | Shikhar Bhushan | |
190 | 39ce7446 | Shikhar Bhushan | # Documents to append as an appendix to all manuals.
|
191 | 39ce7446 | Shikhar Bhushan | #latex_appendices = []
|
192 | 39ce7446 | Shikhar Bhushan | |
193 | 39ce7446 | Shikhar Bhushan | # If false, no module index is generated.
|
194 | 39ce7446 | Shikhar Bhushan | #latex_use_modindex = True
|
195 | 39ce7446 | Shikhar Bhushan | |
196 | 39ce7446 | Shikhar Bhushan | |
197 | 39ce7446 | Shikhar Bhushan | # Example configuration for intersphinx: refer to the Python standard library.
|
198 | 39ce7446 | Shikhar Bhushan | intersphinx_mapping = {'http://docs.python.org/': None} |