Robust and replicable effects of ageing on resting-state brain electrophysiology measured with MEG

1. # -*- coding: utf-8 -*-
2. #
3. # This file is execfile()d with the current directory set to its containing dir.
4. #
5. # Note that not all possible configuration values are present in this
6. # autogenerated file.
7. #
8. # All configuration values have a default; values that are commented out
9. # serve to show the default.
11. import inspect
12. import os
13. import shutil
14. import sys
16. __location__ = os.path.join(
17. os.getcwd(), os.path.dirname(inspect.getfile(inspect.currentframe()))
18. )
20. # If extensions (or modules to document with autodoc) are in another directory,
21. # add these directories to sys.path here. If the directory is relative to the
22. # documentation root, use os.path.abspath to make it absolute, like shown here.
23. sys.path.insert(0, os.path.join(__location__, "../.."))
25. # -- General configuration -----------------------------------------------------
27. # If your documentation needs a minimal Sphinx version, state it here.
28. # needs_sphinx = '1.0'
30. # Add any Sphinx extension module names here, as strings. They can be extensions
31. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
32. extensions = [
33. #"sphinx.ext.autosummary",
34. #"sphinx.ext.autodoc",
35. "sphinx.ext.intersphinx",
36. "sphinx.ext.todo",
37. "sphinx.ext.viewcode",
38. "sphinx.ext.coverage",
39. "sphinx.ext.doctest",
40. "sphinx.ext.ifconfig",
41. "sphinx.ext.mathjax",
42. "sphinx.ext.napoleon",
43. "sphinx_gallery.gen_gallery",
44. "autoapi.extension",
45. ]
46. autoapi_type = "python"
47. autoapi_keep_files = True
48. autoapi_add_toctree_entry = False
49. autoapi_dirs = ["../../osl_ephys"]
51. sphinx_gallery_conf = {
52. "examples_dirs": "tutorials", # path to your example (tutorial) scripts
53. "gallery_dirs": "tutorials_build", # path to where to save gallery generated output
54. }
56. # Add any paths that contain templates here, relative to this directory.
57. # templates_path = ["_templates"]
59. # The suffix of source filenames.
60. source_suffix = ".rst"
62. # The encoding of source files.
63. # source_encoding = 'utf-8-sig'
65. # The master toctree document.
66. master_doc = "index"
68. # General information about the project.
69. project = "osl-ephys"
70. copyright = "2022, OHBA Methods Group, University of Oxford"
71. author = "OHBA Methods Group, University of Oxford"
73. # The version info for the project you're documenting, acts as replacement for
74. # |version| and |release|, also used in various other places throughout the
75. # built documents.
76. #
77. # The short X.Y version.
78. version = "2.0.0" # Is set by calling `setup.py docs`
79. # The full version, including alpha/beta/rc tags.
80. release = "" # Is set by calling `setup.py docs`
82. # The language for content autogenerated by Sphinx. Refer to documentation
83. # for a list of supported languages.
84. # language = None
86. # There are two options for replacing |today|: either, you set today to some
87. # non-false value, then it is used:
88. # today = ''
89. # Else, today_fmt is used as the format for a strftime call.
90. # today_fmt = '%B %d, %Y'
92. # List of patterns, relative to source directory, that match files and
93. # directories to ignore when looking for source files.
94. # exclude_patterns = ["_build"]
96. # The reST default role (used for this markup: `text`) to use for all documents.
97. # default_role = None
99. # If true, '()' will be appended to :func: etc. cross-reference text.
100. # add_function_parentheses = True
102. # If true, the current module name will be prepended to all description
103. # unit titles (such as .. function::).
104. # add_module_names = True
106. # If true, sectionauthor and moduleauthor directives will be shown in the
107. # output. They are ignored by default.
108. # show_authors = False
110. # The name of the Pygments (syntax highlighting) style to use.
111. pygments_style = "sphinx"
113. # A list of ignored prefixes for module index sorting.
114. # modindex_common_prefix = []
116. # If true, keep warnings as "system message" paragraphs in the built documents.
117. # keep_warnings = False
120. # -- Options for HTML output ---------------------------------------------------
122. # The theme to use for HTML and HTML Help pages. See the documentation for
123. # a list of builtin themes.
124. html_theme = "pydata_sphinx_theme"
126. # Theme options are theme-specific and customize the look and feel of a theme
127. # further. For a list of options available for each theme, see the
128. # documentation.
129. html_theme_options = {
130. "gitlab_url": "https://github.com/OHBA-analysis/osl-ephys",
131. }
133. # Add any paths that contain custom themes here, relative to this directory.
134. # html_theme_path = []
136. # The name for this set of Sphinx documents. If None, it defaults to
137. # "<project> v<release> documentation".
138. # try:
139. # from osl_dynamics import __version__ as version
140. # except ImportError:
141. # pass
142. # else:
143. # release = version
144. html_title = "osl-ephys"
146. # A shorter title for the navigation bar. Default is the same as html_title.
147. html_short_title = "osl-ephys"
149. # The name of an image file (relative to this directory) to place at the top
150. # of the sidebar.
151. html_logo = "https://avatars.githubusercontent.com/u/15248840?s=200&v=4"
153. # The name of an image file (within the static path) to use as favicon of the
154. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
155. # pixels large.
156. # html_favicon = None
158. # Add any paths that contain custom static files (such as style sheets) here,
159. # relative to this directory. They are copied after the builtin static files,
160. # so a file named "default.css" will overwrite the builtin "default.css".
161. # html_static_path = ["_static"]
163. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
164. # using the given strftime format.
165. # html_last_updated_fmt = '%b %d, %Y'
167. # If true, SmartyPants will be used to convert quotes and dashes to
168. # typographically correct entities.
169. # html_use_smartypants = True
171. # Custom sidebar templates, maps document names to template names.
172. # html_sidebars = {}
174. # Additional templates that should be rendered to pages, maps page names to
175. # template names.
176. # html_additional_pages = {}
178. # If false, no module index is generated.
179. # html_domain_indices = True
181. # If false, no index is generated.
182. # html_use_index = True
184. # If true, the index is split into individual pages for each letter.
185. # html_split_index = False
187. # If true, links to the reST sources are added to the pages.
188. # html_show_sourcelink = True
190. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
191. # html_show_sphinx = False
193. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
194. # html_show_copyright = False
196. # If true, an OpenSearch description file will be output, and all pages will
197. # contain a <link> tag referring to it. The value of this option must be the
198. # base URL from which the finished HTML is served.
199. # html_use_opensearch = ''
201. # This is the file name suffix for HTML files (e.g. ".xhtml").
202. # html_file_suffix = None
204. # Output file base name for HTML help builder.
205. htmlhelp_basename = "osl-doc"
206. intersphinx_mapping = {
207. 'mne': ('https://mne.tools/stable/', None),
208. 'osl-ephys': ('https://osl-ephys.readthedocs.io/en/stable/', None),
209. 'dask': ('https://distributed.dask.org/en/stable/', None),
210. 'sails': ('https://sails.readthedocs.io/en/stable/', None),
211. 'matplotlib': ('https://matplotlib.org/stable/', None),
212. }

conf.py, under BSD-3-Clause · at the source