|
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 |
|
|
31 | 32 |
|
32 | 33 | # Add any Sphinx extension module names here, as strings. They can be extensions |
33 | 34 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
34 | | -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', |
35 | | - 'sphinx.ext.coverage', 'sphinx.ext.napoleon'] |
| 35 | +extensions = [ |
| 36 | + 'sphinx.ext.autodoc', |
| 37 | + 'sphinx.ext.coverage', |
| 38 | + 'sphinx.ext.napoleon', |
| 39 | + 'sphinx.ext.intersphinx', |
| 40 | + 'm2r', |
| 41 | +] |
36 | 42 |
|
37 | 43 | # Add any paths that contain templates here, relative to this directory. |
38 | 44 | templates_path = ['_templates'] |
39 | 45 |
|
40 | | -# The suffix of source filenames. |
41 | | -source_suffix = '.rst' |
| 46 | +# The suffix(es) of source filenames. |
| 47 | +# You can specify multiple suffix as a list of string: |
| 48 | +# |
| 49 | +source_suffix = ['.rst', '.md'] |
42 | 50 |
|
43 | 51 | # The encoding of source files. |
44 | 52 | # source_encoding = 'utf-8-sig' |
|
47 | 55 | master_doc = 'index' |
48 | 56 |
|
49 | 57 | # General information about the project. |
50 | | -project = 'SrReal' |
| 58 | +project = 'diffpy.srreal' |
51 | 59 | copyright = '%Y, Brookhaven National Laboratory' |
52 | 60 |
|
53 | 61 | # The version info for the project you're documenting, acts as replacement for |
54 | 62 | # |version| and |release|, also used in various other places throughout the |
55 | 63 | # built documents. |
56 | | -sys.path.insert(0, os.path.abspath('../../..')) |
57 | 64 | from setup import versiondata |
58 | 65 | fullversion = versiondata.get('DEFAULT', 'version') |
59 | | -sys.path.remove(os.path.abspath('../../..')) |
60 | 66 | # The short X.Y version. |
61 | 67 | version = ''.join(fullversion.split('.post')[:1]) |
62 | 68 | # The full version, including alpha/beta/rc tags. |
|
108 | 114 |
|
109 | 115 | # The theme to use for HTML and HTML Help pages. See the documentation for |
110 | 116 | # a list of builtin themes. |
111 | | -html_theme = 'default' |
| 117 | +html_theme = 'sphinx_py3doc_enhanced_theme' |
112 | 118 |
|
113 | 119 | # Theme options are theme-specific and customize the look and feel of a theme |
114 | 120 | # further. For a list of options available for each theme, see the |
115 | 121 | # documentation. |
116 | | -# html_theme_options = {} |
117 | | -html_theme_options = {'collapsiblesidebar' : 'true'} |
| 122 | +html_theme_options = { |
| 123 | + 'collapsiblesidebar' : 'true', |
| 124 | + 'navigation_with_keys' : 'true', |
| 125 | +} |
118 | 126 |
|
119 | 127 | # Add any paths that contain custom themes here, relative to this directory. |
120 | 128 | # html_theme_path = [] |
|
182 | 190 | # html_file_suffix = None |
183 | 191 |
|
184 | 192 | # Output file base name for HTML help builder. |
185 | | -htmlhelp_basename = 'SrRealdoc' |
| 193 | +htmlhelp_basename = 'srrealdoc' |
186 | 194 |
|
187 | 195 |
|
188 | 196 | # -- Options for LaTeX output -------------------------------------------------- |
|
201 | 209 | # Grouping the document tree into LaTeX files. List of tuples |
202 | 210 | # (source start file, target name, title, author, documentclass [howto/manual]). |
203 | 211 | latex_documents = [ |
204 | | - ('index', 'SrReal_manual.tex', 'SrReal Documentation', |
| 212 | + ('index', 'diffpy.srreal.tex', 'diffpy.srreal Documentation', |
205 | 213 | ab_authors, 'manual'), |
206 | 214 | ] |
207 | 215 |
|
|
231 | 239 | # One entry per manual page. List of tuples |
232 | 240 | # (source start file, name, description, authors, manual section). |
233 | 241 | man_pages = [ |
234 | | - ('index', 'srreal', 'SrReal Documentation', |
| 242 | + ('index', 'diffpy.srreal', 'diffpy.srreal Documentation', |
235 | 243 | ab_authors, 1) |
236 | 244 | ] |
237 | 245 |
|
|
245 | 253 | # (source start file, target name, title, author, |
246 | 254 | # dir menu entry, description, category) |
247 | 255 | texinfo_documents = [ |
248 | | - ('index', 'SrReal', 'SrReal Documentation', |
249 | | - ab_authors, 'SrReal', 'One line description of project.', |
| 256 | + ('index', 'diffpy.srreal', 'diffpy.srreal Documentation', |
| 257 | + ab_authors, 'diffpy.srreal', 'One line description of project.', |
250 | 258 | 'Miscellaneous'), |
251 | 259 | ] |
252 | 260 |
|
|
261 | 269 |
|
262 | 270 |
|
263 | 271 | # Example configuration for intersphinx: refer to the Python standard library. |
264 | | -# intersphinx_mapping = {'http://docs.python.org/': None} |
| 272 | +intersphinx_mapping = { |
| 273 | + 'numpy': ('https://docs.scipy.org/doc/numpy', None), |
| 274 | + 'python' : ('https://docs.python.org/3.7', None), |
| 275 | +} |
0 commit comments