|
19 | 19 | # |
20 | 20 | import os |
21 | 21 | import sys |
| 22 | + |
22 | 23 | sys.path.insert(0, os.path.abspath('../..')) |
23 | 24 |
|
24 | 25 | from pysampling.version import __version__ |
25 | 26 |
|
26 | 27 | # show doc |
27 | 28 | autoclass_content = 'both' |
28 | 29 |
|
29 | | - |
30 | 30 | # -- General configuration ------------------------------------------------ |
31 | 31 |
|
32 | 32 | # If your documentation needs a minimal Sphinx version, state it here. |
|
37 | 37 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
38 | 38 | # ones. |
39 | 39 | extensions = ['sphinx.ext.autodoc', |
40 | | - 'sphinx.ext.todo', |
41 | | - 'sphinxcontrib.bibtex', |
42 | | - 'sphinxcontrib.napoleon', |
43 | | - 'nbsphinx' |
44 | | -] |
| 40 | + 'sphinx.ext.todo', |
| 41 | + 'sphinxcontrib.bibtex', |
| 42 | + 'sphinxcontrib.napoleon', |
| 43 | + 'nbsphinx' |
| 44 | + ] |
45 | 45 |
|
46 | 46 | # Add any paths that contain templates here, relative to this directory. |
47 | 47 | templates_path = ['_templates'] |
|
79 | 79 | # List of patterns, relative to source directory, that match files and |
80 | 80 | # directories to ignore when looking for source files. |
81 | 81 | # This patterns also effect to html_static_path and html_extra_path |
82 | | -exclude_patterns = [] |
| 82 | +exclude_patterns = ['**.ipynb_checkpoints'] |
83 | 83 |
|
84 | 84 | # The name of the Pygments (syntax highlighting) style to use. |
85 | 85 | pygments_style = 'sphinx' |
86 | 86 |
|
87 | 87 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
88 | 88 | todo_include_todos = True |
89 | 89 |
|
90 | | - |
91 | 90 | # -- Options for HTML output ---------------------------------------------- |
92 | 91 |
|
93 | 92 | # distable or enable dependent on where the build will be used |
94 | 93 | # html_baseurl='' |
95 | 94 |
|
96 | 95 | # The theme to use for HTML and HTML Help pages. See the documentation for |
97 | 96 | # a list of builtin themes. |
98 | | -#html_theme = 'alabaster' |
| 97 | +# html_theme = 'alabaster' |
99 | 98 | html_theme = 'sphinx_rtd_theme' |
100 | | - |
| 99 | +html_title = "pysampling" |
101 | 100 |
|
102 | 101 | # Theme options are theme-specific and customize the look and feel of a theme |
103 | 102 | # further. For a list of options available for each theme, see the |
104 | 103 | # documentation. |
105 | 104 | # |
106 | | -# html_theme_options = {} |
| 105 | +html_theme_options = dict( |
| 106 | + github_url="https://github.com/julesy89/pysampling" |
| 107 | +) |
107 | 108 |
|
108 | 109 | # Add any paths that contain custom static files (such as style sheets) here, |
109 | 110 | # relative to this directory. They are copied after the builtin static files, |
|
122 | 123 | ] |
123 | 124 | } |
124 | 125 |
|
125 | | - |
126 | 126 | # -- Options for HTMLHelp output ------------------------------------------ |
127 | 127 |
|
128 | 128 | # Output file base name for HTML help builder. |
129 | 129 | htmlhelp_basename = 'pysamplingdoc' |
130 | 130 |
|
131 | | - |
132 | 131 | # -- Options for LaTeX output --------------------------------------------- |
133 | 132 |
|
134 | 133 | latex_elements = { |
|
147 | 146 | # Latex figure (float) alignment |
148 | 147 | # |
149 | 148 | # 'figure_align': 'htbp', |
150 | | - 'extraclassoptions' : 'openany', |
| 149 | + 'extraclassoptions': 'openany', |
151 | 150 | } |
152 | 151 |
|
153 | 152 | # Grouping the document tree into LaTeX files. List of tuples |
|
158 | 157 | 'Julian Blank', 'howto'), |
159 | 158 | ] |
160 | 159 |
|
161 | | - |
162 | 160 | # -- Options for manual page output --------------------------------------- |
163 | 161 |
|
164 | 162 | # One entry per manual page. List of tuples |
|
168 | 166 | [author], 1) |
169 | 167 | ] |
170 | 168 |
|
171 | | - |
172 | 169 | # -- Options for Texinfo output ------------------------------------------- |
173 | 170 |
|
174 | 171 | # Grouping the document tree into Texinfo files. List of tuples |
|
179 | 176 | author, 'pysampling', 'One line description of project.', |
180 | 177 | 'Miscellaneous'), |
181 | 178 | ] |
182 | | - |
183 | | - |
184 | | - |
0 commit comments