conf.py 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Elephant documentation build configuration file, created by
  4. # sphinx-quickstart on Wed Feb 5 17:11:26 2014.
  5. #
  6. # This file is execfile()d with the current directory set to its containing dir.
  7. #
  8. # Note that not all possible configuration values are present in this
  9. # autogenerated file.
  10. #
  11. # All configuration values have a default; values that are commented out
  12. # serve to show the default.
  13. import sys, os
  14. # If extensions (or modules to document with autodoc) are in another directory,
  15. # add these directories to sys.path here. If the directory is relative to the
  16. # documentation root, use os.path.abspath to make it absolute, like shown here.
  17. sys.path.insert(0, '..')
  18. # -- General configuration -----------------------------------------------------
  19. # If your documentation needs a minimal Sphinx version, state it here.
  20. #needs_sphinx = '1.0'
  21. # Add any Sphinx extension module names here, as strings. They can be extensions
  22. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  23. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx',
  24. 'sphinx.ext.todo', 'sphinx.ext.pngmath', 'sphinx.ext.mathjax',
  25. 'sphinx.ext.viewcode', 'numpydoc']
  26. # Add any paths that contain templates here, relative to this directory.
  27. templates_path = ['_templates']
  28. # The suffix of source filenames.
  29. source_suffix = '.rst'
  30. # The encoding of source files.
  31. #source_encoding = 'utf-8-sig'
  32. # The master toctree document.
  33. master_doc = 'index'
  34. # General information about the project.
  35. project = u'Elephant'
  36. authors = u'Elephant authors and contributors'
  37. copyright = u'2014-2017, ' + authors
  38. # The version info for the project you're documenting, acts as replacement for
  39. # |version| and |release|, also used in various other places throughout the
  40. # built documents.
  41. #
  42. # The short X.Y version.
  43. version = '0.4'
  44. # The full version, including alpha/beta/rc tags.
  45. release = '0.4.1'
  46. # The language for content autogenerated by Sphinx. Refer to documentation
  47. # for a list of supported languages.
  48. #language = None
  49. # There are two options for replacing |today|: either, you set today to some
  50. # non-false value, then it is used:
  51. #today = ''
  52. # Else, today_fmt is used as the format for a strftime call.
  53. #today_fmt = '%B %d, %Y'
  54. # List of patterns, relative to source directory, that match files and
  55. # directories to ignore when looking for source files.
  56. exclude_patterns = ['_build']
  57. # The reST default role (used for this markup: `text`) to use for all documents.
  58. #default_role = None
  59. # If true, '()' will be appended to :func: etc. cross-reference text.
  60. #add_function_parentheses = True
  61. # If true, the current module name will be prepended to all description
  62. # unit titles (such as .. function::).
  63. #add_module_names = True
  64. # If true, sectionauthor and moduleauthor directives will be shown in the
  65. # output. They are ignored by default.
  66. #show_authors = False
  67. # The name of the Pygments (syntax highlighting) style to use.
  68. pygments_style = 'sphinx'
  69. # A list of ignored prefixes for module index sorting.
  70. #modindex_common_prefix = []
  71. # -- Options for HTML output ---------------------------------------------------
  72. # The theme to use for HTML and HTML Help pages. See the documentation for
  73. # a list of builtin themes.
  74. html_theme = 'sphinxdoc'
  75. # Theme options are theme-specific and customize the look and feel of a theme
  76. # further. For a list of options available for each theme, see the
  77. # documentation.
  78. #html_theme_options = {}
  79. # Add any paths that contain custom themes here, relative to this directory.
  80. #html_theme_path = []
  81. # The name for this set of Sphinx documents. If None, it defaults to
  82. # "<project> v<release> documentation".
  83. #html_title = None
  84. # A shorter title for the navigation bar. Default is the same as html_title.
  85. #html_short_title = None
  86. # The name of an image file (relative to this directory) to place at the top
  87. # of the sidebar.
  88. html_logo = 'images/elephant_logo_sidebar.png'
  89. # The name of an image file (within the static path) to use as favicon of the
  90. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  91. # pixels large.
  92. html_favicon = 'images/elephant_favicon.ico'
  93. # Add any paths that contain custom static files (such as style sheets) here,
  94. # relative to this directory. They are copied after the builtin static files,
  95. # so a file named "default.css" will overwrite the builtin "default.css".
  96. html_static_path = ['_static']
  97. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  98. # using the given strftime format.
  99. #html_last_updated_fmt = '%b %d, %Y'
  100. # If true, SmartyPants will be used to convert quotes and dashes to
  101. # typographically correct entities.
  102. html_use_smartypants = True
  103. # Custom sidebar templates, maps document names to template names.
  104. #html_sidebars = {}
  105. # Additional templates that should be rendered to pages, maps page names to
  106. # template names.
  107. #html_additional_pages = {}
  108. # If false, no module index is generated.
  109. #html_domain_indices = True
  110. # If false, no index is generated.
  111. html_use_index = True
  112. # If true, the index is split into individual pages for each letter.
  113. #html_split_index = False
  114. # If true, links to the reST sources are added to the pages.
  115. #html_show_sourcelink = True
  116. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  117. #html_show_sphinx = True
  118. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  119. #html_show_copyright = True
  120. # If true, an OpenSearch description file will be output, and all pages will
  121. # contain a <link> tag referring to it. The value of this option must be the
  122. # base URL from which the finished HTML is served.
  123. #html_use_opensearch = ''
  124. # This is the file name suffix for HTML files (e.g. ".xhtml").
  125. #html_file_suffix = None
  126. # Output file base name for HTML help builder.
  127. htmlhelp_basename = 'elephantdoc'
  128. # -- Options for LaTeX output --------------------------------------------------
  129. latex_elements = {
  130. # The paper size ('letterpaper' or 'a4paper').
  131. #'papersize': 'letterpaper',
  132. # The font size ('10pt', '11pt' or '12pt').
  133. #'pointsize': '10pt',
  134. # Additional stuff for the LaTeX preamble.
  135. #'preamble': '',
  136. }
  137. # Grouping the document tree into LaTeX files. List of tuples
  138. # (source start file, target name, title, author, documentclass [howto/manual]).
  139. latex_documents = [
  140. ('index', 'elephant.tex', u'Elephant Documentation',
  141. authors, 'manual'),
  142. ]
  143. # The name of an image file (relative to this directory) to place at the top of
  144. # the title page.
  145. #latex_logo = None
  146. # For "manual" documents, if this is true, then toplevel headings are parts,
  147. # not chapters.
  148. #latex_use_parts = False
  149. # If true, show page references after internal links.
  150. #latex_show_pagerefs = False
  151. # If true, show URL addresses after external links.
  152. #latex_show_urls = False
  153. # Documents to append as an appendix to all manuals.
  154. #latex_appendices = []
  155. # If false, no module index is generated.
  156. #latex_domain_indices = True
  157. # -- Options for manual page output --------------------------------------------
  158. # One entry per manual page. List of tuples
  159. # (source start file, name, description, authors, manual section).
  160. man_pages = [
  161. ('index', 'elephant', u'Elephant Documentation',
  162. [authors], 1)
  163. ]
  164. # If true, show URL addresses after external links.
  165. #man_show_urls = False
  166. # -- Options for Texinfo output ------------------------------------------------
  167. # Grouping the document tree into Texinfo files. List of tuples
  168. # (source start file, target name, title, author,
  169. # dir menu entry, description, category)
  170. texinfo_documents = [
  171. ('index', 'Elephant', u'Elephant Documentation',
  172. authors, 'Elephant', 'Elephant is a package for the analysis of neurophysiology data.',
  173. 'Miscellaneous'),
  174. ]
  175. # Documents to append as an appendix to all manuals.
  176. #texinfo_appendices = []
  177. # If false, no module index is generated.
  178. #texinfo_domain_indices = True
  179. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  180. #texinfo_show_urls = 'footnote'
  181. # -- Options for Epub output ---------------------------------------------------
  182. # Bibliographic Dublin Core info.
  183. epub_title = project
  184. epub_author = authors
  185. epub_publisher = authors
  186. epub_copyright = copyright
  187. # The language of the text. It defaults to the language option
  188. # or en if the language is not set.
  189. #epub_language = ''
  190. # The scheme of the identifier. Typical schemes are ISBN or URL.
  191. #epub_scheme = ''
  192. # The unique identifier of the text. This can be a ISBN number
  193. # or the project homepage.
  194. #epub_identifier = ''
  195. # A unique identification for the text.
  196. #epub_uid = ''
  197. # A tuple containing the cover image and cover page html template filenames.
  198. #epub_cover = ()
  199. # HTML files that should be inserted before the pages created by sphinx.
  200. # The format is a list of tuples containing the path and title.
  201. #epub_pre_files = []
  202. # HTML files shat should be inserted after the pages created by sphinx.
  203. # The format is a list of tuples containing the path and title.
  204. #epub_post_files = []
  205. # A list of files that should not be packed into the epub file.
  206. #epub_exclude_files = []
  207. # The depth of the table of contents in toc.ncx.
  208. #epub_tocdepth = 3
  209. # Allow duplicate toc entries.
  210. #epub_tocdup = True
  211. # Example configuration for intersphinx: refer to the Python standard library.
  212. intersphinx_mapping = {'http://docs.python.org/': None}
  213. # Use more reliable mathjax source
  214. mathjax_path = 'https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
  215. # Remove the copyright notice from docstrings:
  216. def process_docstring_remove_copyright(app, what, name, obj, options, lines):
  217. copyright_line = None
  218. for i,line in enumerate(lines):
  219. if line.startswith(':copyright:'):
  220. copyright_line = i
  221. break
  222. if copyright_line:
  223. while len(lines) > copyright_line:
  224. lines.pop()
  225. def setup(app):
  226. app.connect('autodoc-process-docstring', process_docstring_remove_copyright)