|
1 | 1 | #!/usr/bin/env python |
2 | 2 | # -*- coding: utf-8 -*- |
3 | 3 | # |
4 | | -# diffpy.SrReal documentation build configuration file, created by |
| 4 | +# diffpy.srreal documentation build configuration file, created by |
5 | 5 | # sphinx-quickstart on Tue Oct 22 12:02:48 2013. |
6 | 6 | # |
7 | 7 | # This file is execfile()d with the current directory set to its containing dir. |
|
12 | 12 | # All configuration values have a default; values that are commented out |
13 | 13 | # serve to show the default. |
14 | 14 |
|
15 | | -import sys, os |
| 15 | +import sys |
| 16 | +import os |
16 | 17 | import time |
17 | 18 |
|
18 | 19 | # If extensions (or modules to document with autodoc) are in another directory, |
19 | 20 | # add these directories to sys.path here. If the directory is relative to the |
20 | 21 | # 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('../../..')) |
| 22 | +#sys.path.insert(0, os.path.abspath('.')) |
| 23 | +sys.path.insert(0, os.path.abspath('../../..')) |
23 | 24 |
|
24 | 25 | # abbreviations |
25 | | -ab_authors = 'Pavol Juhás, Christopher L. Farrow, Simon J.L. Billinge group' |
| 26 | +ab_authors = u'Pavol Juhás, Christopher L. Farrow, Simon J.L. Billinge group' |
26 | 27 |
|
27 | 28 | # -- General configuration ----------------------------------------------------- |
28 | 29 |
|
|
51 | 52 | master_doc = 'index' |
52 | 53 |
|
53 | 54 | # General information about the project. |
54 | | -project = 'SrReal' |
| 55 | +project = 'diffpy.srreal' |
55 | 56 | copyright = '%Y, Brookhaven National Laboratory' |
56 | 57 |
|
57 | 58 | # The version info for the project you're documenting, acts as replacement for |
58 | 59 | # |version| and |release|, also used in various other places throughout the |
59 | 60 | # built documents. |
60 | | -sys.path.insert(0, os.path.abspath('../../..')) |
61 | 61 | from setup import versiondata |
62 | 62 | fullversion = versiondata.get('DEFAULT', 'version') |
63 | | -sys.path.remove(os.path.abspath('../../..')) |
64 | 63 | # The short X.Y version. |
65 | 64 | version = ''.join(fullversion.split('.post')[:1]) |
66 | 65 | # The full version, including alpha/beta/rc tags. |
|
188 | 187 | # html_file_suffix = None |
189 | 188 |
|
190 | 189 | # Output file base name for HTML help builder. |
191 | | -htmlhelp_basename = 'SrRealdoc' |
| 190 | +htmlhelp_basename = 'srrealdoc' |
192 | 191 |
|
193 | 192 |
|
194 | 193 | # -- Options for LaTeX output -------------------------------------------------- |
|
207 | 206 | # Grouping the document tree into LaTeX files. List of tuples |
208 | 207 | # (source start file, target name, title, author, documentclass [howto/manual]). |
209 | 208 | latex_documents = [ |
210 | | - ('index', 'SrReal_manual.tex', 'SrReal Documentation', |
| 209 | + ('index', 'diffpy.srreal.tex', 'diffpy.srreal Documentation', |
211 | 210 | ab_authors, 'manual'), |
212 | 211 | ] |
213 | 212 |
|
|
237 | 236 | # One entry per manual page. List of tuples |
238 | 237 | # (source start file, name, description, authors, manual section). |
239 | 238 | man_pages = [ |
240 | | - ('index', 'srreal', 'SrReal Documentation', |
| 239 | + ('index', 'diffpy.srreal', 'diffpy.srreal Documentation', |
241 | 240 | ab_authors, 1) |
242 | 241 | ] |
243 | 242 |
|
|
251 | 250 | # (source start file, target name, title, author, |
252 | 251 | # dir menu entry, description, category) |
253 | 252 | texinfo_documents = [ |
254 | | - ('index', 'SrReal', 'SrReal Documentation', |
255 | | - ab_authors, 'SrReal', 'One line description of project.', |
| 253 | + ('index', 'diffpy.srreal', 'diffpy.srreal Documentation', |
| 254 | + ab_authors, 'diffpy.srreal', 'One line description of project.', |
256 | 255 | 'Miscellaneous'), |
257 | 256 | ] |
258 | 257 |
|
|
0 commit comments