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