|
3 | 3 | # python-ipmi documentation build configuration file, created by
|
4 | 4 | # sphinx-quickstart on Tue Jun 18 09:15:24 2013.
|
5 | 5 | #
|
6 |
| -# This file is execfile()d with the current directory set to its containing dir. |
| 6 | +# This file is execfile()d with the current directory set to |
| 7 | +# its containing dir. |
7 | 8 | #
|
8 | 9 | # Note that not all possible configuration values are present in this
|
9 | 10 | # autogenerated file.
|
10 | 11 | #
|
11 | 12 | # All configuration values have a default; values that are commented out
|
12 | 13 | # serve to show the default.
|
13 | 14 |
|
14 |
| -import sys, os |
| 15 | +import os |
| 16 | +import sys |
15 | 17 |
|
16 | 18 | # If extensions (or modules to document with autodoc) are in another directory,
|
17 | 19 | # add these directories to sys.path here. If the directory is relative to the
|
18 | 20 | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
| 21 | +sys.path.insert(0, os.path.abspath('../../')) |
| 22 | +sys.path.insert(0, os.path.abspath('../')) |
19 | 23 | sys.path.insert(0, os.path.abspath('.'))
|
20 | 24 |
|
21 |
| -# -- General configuration ----------------------------------------------------- |
| 25 | +# -- General configuration --------------------------------------------------- |
22 | 26 |
|
23 | 27 | # If your documentation needs a minimal Sphinx version, state it here.
|
24 | 28 | #needs_sphinx = '1.0'
|
25 | 29 |
|
26 |
| -# Add any Sphinx extension module names here, as strings. They can be extensions |
27 |
| -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
| 30 | +# Add any Sphinx extension module names here, as strings. They can be |
| 31 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
28 | 32 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.pngmath']
|
29 | 33 |
|
30 | 34 | # Add any paths that contain templates here, relative to this directory.
|
|
47 | 51 | # |version| and |release|, also used in various other places throughout the
|
48 | 52 | # built documents.
|
49 | 53 | #
|
50 |
| -# The short X.Y version. |
51 |
| -version = '0.5' |
| 54 | +from ipmi.version import version_info |
52 | 55 | # The full version, including alpha/beta/rc tags.
|
53 |
| -release = '0.5' |
| 56 | +release = version_info.release_string() |
| 57 | +# The short X.Y version. |
| 58 | +version = version_info.version_string() |
54 | 59 |
|
55 | 60 | # The language for content autogenerated by Sphinx. Refer to documentation
|
56 | 61 | # for a list of supported languages.
|
|
66 | 71 | # directories to ignore when looking for source files.
|
67 | 72 | exclude_patterns = ['_build']
|
68 | 73 |
|
69 |
| -# The reST default role (used for this markup: `text`) to use for all documents. |
| 74 | +# The reST default role (used for this markup: `text`) to use for all documents |
70 | 75 | #default_role = None
|
71 | 76 |
|
72 | 77 | # If true, '()' will be appended to :func: etc. cross-reference text.
|
|
87 | 92 | #modindex_common_prefix = []
|
88 | 93 |
|
89 | 94 |
|
90 |
| -# -- Options for HTML output --------------------------------------------------- |
| 95 | +# -- Options for HTML output ------------------------------------------------- |
91 | 96 |
|
92 | 97 | # The theme to use for HTML and HTML Help pages. See the documentation for
|
93 | 98 | # a list of builtin themes.
|
|
167 | 172 | htmlhelp_basename = 'python-ipmidoc'
|
168 | 173 |
|
169 | 174 |
|
170 |
| -# -- Options for LaTeX output -------------------------------------------------- |
| 175 | +# -- Options for LaTeX output ------------------------------------------------- |
171 | 176 |
|
172 | 177 | # The paper size ('letter' or 'a4').
|
173 | 178 | #latex_paper_size = 'letter'
|
|
176 | 181 | #latex_font_size = '10pt'
|
177 | 182 |
|
178 | 183 | # Grouping the document tree into LaTeX files. List of tuples
|
179 |
| -# (source start file, target name, title, author, documentclass [howto/manual]). |
| 184 | +# (source start file, target name, title, author, documentclass [howto/manual]) |
180 | 185 | latex_documents = [
|
181 |
| - ('index', 'python-ipmi.tex', u'python-ipmi Documentation', |
182 |
| - u'Jarrod Johnson \\textless{}[email protected]\\textgreater{}', 'manual'), |
| 186 | + ('index', 'python-ipmi.tex', u'python-ipmi Documentation', |
| 187 | + u'Jarrod Johnson \\textless{}[email protected]\\textgreater{}', |
| 188 | + 'manual'), |
183 | 189 | ]
|
184 | 190 |
|
185 | 191 | # The name of an image file (relative to this directory) to place at the top of
|
|
206 | 212 | #latex_domain_indices = True
|
207 | 213 |
|
208 | 214 |
|
209 |
| -# -- Options for manual page output -------------------------------------------- |
| 215 | +# -- Options for manual page output ------------------------------------------- |
210 | 216 |
|
211 | 217 | # One entry per manual page. List of tuples
|
212 | 218 | # (source start file, name, description, authors, manual section).
|
|
0 commit comments