1+ # -*- coding: utf-8 -*-
2+ #
3+ # Configuration file for the Sphinx documentation builder.
4+ #
5+ # This file does only contain a selection of the most common options. For a
6+ # full list see the documentation:
7+ # http://www.sphinx-doc.org/en/master/config
8+
9+ # -- Path setup --------------------------------------------------------------
10+
11+ # If extensions (or modules to document with autodoc) are in another directory,
12+ # add these directories to sys.path here. If the directory is relative to the
13+ # documentation root, use os.path.abspath to make it absolute, like shown here.
14+ #
15+ # import os
16+ # import sys
17+ # sys.path.insert(0, os.path.abspath('../../'))
18+
19+ import larray_editor
20+ print ("larray-editor: {}, {}" .format (larray_editor .__version__ , larray_editor .__file__ ))
21+
22+ # -- Project information -----------------------------------------------------
23+
24+ project = 'LArray-Editor'
25+ copyright = '2017-2019, Gaëtan de Menten, Geert Bryon, Johan Duyck, Alix Damman'
26+ author = 'Gaëtan de Menten, Geert Bryon, Johan Duyck, Alix Damman'
27+
28+ # The short X.Y version
29+ version = larray_editor .__version__
30+ # The full version, including alpha/beta/rc tags
31+ release = larray_editor .__version__
32+
33+
34+ # -- General configuration ---------------------------------------------------
35+
36+ # If your documentation needs a minimal Sphinx version, state it here.
37+ #
38+ # needs_sphinx = '1.0'
39+
40+ # Add any Sphinx extension module names here, as strings. They can be
41+ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
42+ # ones.
43+ extensions = [
44+ 'sphinx.ext.autodoc' ,
45+ 'sphinx.ext.autosummary' ,
46+ 'sphinx.ext.doctest' ,
47+ 'sphinx.ext.intersphinx' ,
48+ 'sphinx.ext.mathjax' ,
49+ 'sphinx.ext.ifconfig' ,
50+ 'sphinx.ext.viewcode' ,
51+ 'sphinx.ext.extlinks' ,
52+ 'numpydoc' ,
53+ ]
54+
55+ extlinks = {
56+ 'issue' : ('https://github.com/larray-project/larray-editor/issues/%s' , 'issue ' ),
57+ }
58+
59+ # scan all found documents for autosummary directives, and to generate stub pages for each.
60+ # The new files will be placed in the directories specified in the :toctree: options of the directives.
61+ autosummary_generate = True
62+
63+ numpydoc_class_members_toctree = True
64+ # avoid pulling in base class (ndarray) methods
65+ numpydoc_show_class_members = False
66+
67+ # ==============================================================
68+
69+ # Add any paths that contain templates here, relative to this directory.
70+ templates_path = ['_templates' ]
71+
72+ # The suffix(es) of source filenames.
73+ # You can specify multiple suffix as a list of string:
74+ #
75+ # source_suffix = ['.rst', '.md']
76+ source_suffix = '.rst'
77+
78+ # The master toctree document.
79+ master_doc = 'index'
80+
81+ # The language for content autogenerated by Sphinx. Refer to documentation
82+ # for a list of supported languages.
83+ #
84+ # This is also used if you do content translation via gettext catalogs.
85+ # Usually you set "language" from the command line for these cases.
86+ language = None
87+
88+ # List of patterns, relative to source directory, that match files and
89+ # directories to ignore when looking for source files.
90+ # This pattern also affects html_static_path and html_extra_path.
91+ exclude_patterns = ['_build' , '**.ipynb_checkpoints' ]
92+
93+ # The name of the Pygments (syntax highlighting) style to use.
94+ pygments_style = 'sphinx'
95+
96+
97+ # -- Options for HTML output -------------------------------------------------
98+
99+ # The theme to use for HTML and HTML Help pages. See the documentation for
100+ # a list of builtin themes.
101+ #
102+ html_theme = 'sphinx_rtd_theme'
103+
104+ # Theme options are theme-specific and customize the look and feel of a theme
105+ # further. For a list of options available for each theme, see the
106+ # documentation.
107+ #
108+ # html_theme_options = {}
109+
110+ # Add any paths that contain custom static files (such as style sheets) here,
111+ # relative to this directory. They are copied after the builtin static files,
112+ # so a file named "default.css" will overwrite the builtin "default.css".
113+ html_static_path = ['_static' ]
114+
115+ # Custom sidebar templates, must be a dictionary that maps document names
116+ # to template names.
117+ #
118+ # The default sidebars (for documents that don't match any pattern) are
119+ # defined by theme itself. Builtin themes are using these templates by
120+ # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
121+ # 'searchbox.html']``.
122+ #
123+ # html_sidebars = {}
124+
125+
126+ # -- Options for HTMLHelp output ---------------------------------------------
127+
128+ # Output file base name for HTML help builder.
129+ htmlhelp_basename = 'larray-editor'
130+
131+
132+ # -- Options for LaTeX output ------------------------------------------------
133+
134+ latex_elements = {
135+ # The paper size ('letterpaper' or 'a4paper').
136+ #
137+ # 'papersize': 'letterpaper',
138+
139+ # The font size ('10pt', '11pt' or '12pt').
140+ #
141+ # 'pointsize': '10pt',
142+
143+ # Additional stuff for the LaTeX preamble.
144+ #
145+ # 'preamble': '',
146+
147+ # Latex figure (float) alignment
148+ #
149+ # 'figure_align': 'htbp',
150+ }
151+
152+ # Grouping the document tree into LaTeX files. List of tuples
153+ # (source start file, target name, title,
154+ # author, documentclass [howto, manual, or own class]).
155+ latex_documents = [
156+ (master_doc , 'LArray-Editor.tex' , 'LArray-Editor Documentation' ,
157+ 'Gaëtan de Menten, Geert Bryon, Johan Duyck, Alix Damman' , 'manual' ),
158+ ]
159+
160+
161+ # -- Options for manual page output ------------------------------------------
162+
163+ # One entry per manual page. List of tuples
164+ # (source start file, name, description, authors, manual section).
165+ man_pages = [
166+ (master_doc , 'larray-editor' , 'LArray-Editor Documentation' ,
167+ [author ], 1 )
168+ ]
169+
170+
171+ # -- Options for Texinfo output ----------------------------------------------
172+
173+ # Grouping the document tree into Texinfo files. List of tuples
174+ # (source start file, target name, title, author,
175+ # dir menu entry, description, category)
176+ texinfo_documents = [
177+ (master_doc , 'LArray-Editor' , 'LArray-Editor Documentation' ,
178+ author , 'LArray-Editor' , 'One line description of project.' ,
179+ 'Miscellaneous' ),
180+ ]
181+
182+
183+ # -- Options for Epub output -------------------------------------------------
184+
185+ # Bibliographic Dublin Core info.
186+ epub_title = project
187+
188+ # The unique identifier of the text. This can be a ISBN number
189+ # or the project homepage.
190+ #
191+ # epub_identifier = ''
192+
193+ # A unique identification for the text.
194+ #
195+ # epub_uid = ''
196+
197+ # A list of files that should not be packed into the epub file.
198+ epub_exclude_files = ['search.html' ]
199+
200+
201+ # -- Extension configuration -------------------------------------------------
202+
203+ # -- Options for intersphinx extension ---------------------------------------
204+
205+ # Example configuration for intersphinx: refer to the Python standard library.
206+ intersphinx_mapping = {'https://docs.python.org/3' : None }
0 commit comments