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+
20+ # -- Project information -----------------------------------------------------
21+
22+ project = 'oceans'
23+ copyright = '2018, Filipe Fernandes'
24+ author = 'Filipe Fernandes'
25+
26+ from oceans ._version import get_versions
27+ version = release = get_versions ()['version' ]
28+ del get_versions
29+
30+ # -- General configuration ---------------------------------------------------
31+
32+ # If your documentation needs a minimal Sphinx version, state it here.
33+ #
34+ # needs_sphinx = '1.0'
35+
36+ # Add any Sphinx extension module names here, as strings. They can be
37+ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
38+ # ones.
39+ extensions = [
40+ 'sphinx.ext.autodoc' ,
41+ 'sphinx.ext.mathjax' ,
42+ 'sphinx.ext.githubpages' ,
43+ 'sphinx.ext.viewcode' ,
44+ 'sphinx.ext.napoleon' ,
45+ 'nbsphinx' ,
46+ ]
47+
48+ # Add any paths that contain templates here, relative to this directory.
49+ templates_path = ['_templates' ]
50+
51+ # The suffix(es) of source filenames.
52+ # You can specify multiple suffix as a list of string:
53+ #
54+ # source_suffix = ['.rst', '.md']
55+ source_suffix = '.rst'
56+
57+ # The master toctree document.
58+ master_doc = 'index'
59+
60+ # The language for content autogenerated by Sphinx. Refer to documentation
61+ # for a list of supported languages.
62+ #
63+ # This is also used if you do content translation via gettext catalogs.
64+ # Usually you set "language" from the command line for these cases.
65+ language = None
66+
67+ # List of patterns, relative to source directory, that match files and
68+ # directories to ignore when looking for source files.
69+ # This pattern also affects html_static_path and html_extra_path.
70+ exclude_patterns = []
71+
72+ # The name of the Pygments (syntax highlighting) style to use.
73+ pygments_style = None
74+
75+
76+ # -- Options for HTML output -------------------------------------------------
77+
78+ # The theme to use for HTML and HTML Help pages. See the documentation for
79+ # a list of builtin themes.
80+ #
81+ html_theme = 'alabaster'
82+
83+ # Theme options are theme-specific and customize the look and feel of a theme
84+ # further. For a list of options available for each theme, see the
85+ # documentation.
86+ #
87+ html_theme_options = {
88+ 'logo' : 'logo.png' ,
89+ 'logo_name' : 'oceans' ,
90+ 'github_user' : 'pyoceans' ,
91+ 'github_repo' : 'oceans' ,
92+ 'github_banner' : True ,
93+ 'travis_button' : True ,
94+ 'fixed_sidebar' : True ,
95+ }
96+
97+ # Add any paths that contain custom static files (such as style sheets) here,
98+ # relative to this directory. They are copied after the builtin static files,
99+ # so a file named "default.css" will overwrite the builtin "default.css".
100+ html_static_path = ['_static' ]
101+
102+ # Custom sidebar templates, must be a dictionary that maps document names
103+ # to template names.
104+ #
105+ # The default sidebars (for documents that don't match any pattern) are
106+ # defined by theme itself. Builtin themes are using these templates by
107+ # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
108+ # 'searchbox.html']``.
109+ #
110+ html_sidebars = {
111+ '**' : [
112+ 'about.html' ,
113+ 'navigation.html' ,
114+ 'relations.html' , # needs 'show_related': True theme option to display
115+ 'searchbox.html' ,
116+ 'donate.html' ,
117+ ]
118+ }
119+
120+
121+ # -- Options for HTMLHelp output ---------------------------------------------
122+
123+ # Output file base name for HTML help builder.
124+ htmlhelp_basename = 'oceansdoc'
125+
126+
127+ # -- Options for LaTeX output ------------------------------------------------
128+
129+ latex_elements = {
130+ # The paper size ('letterpaper' or 'a4paper').
131+ #
132+ # 'papersize': 'letterpaper',
133+
134+ # The font size ('10pt', '11pt' or '12pt').
135+ #
136+ # 'pointsize': '10pt',
137+
138+ # Additional stuff for the LaTeX preamble.
139+ #
140+ # 'preamble': '',
141+
142+ # Latex figure (float) alignment
143+ #
144+ # 'figure_align': 'htbp',
145+ }
146+
147+ # Grouping the document tree into LaTeX files. List of tuples
148+ # (source start file, target name, title,
149+ # author, documentclass [howto, manual, or own class]).
150+ latex_documents = [
151+ (master_doc , 'oceans.tex' , 'oceans Documentation' ,
152+ 'Filipe Fernandes' , 'manual' ),
153+ ]
154+
155+
156+ # -- Options for manual page output ------------------------------------------
157+
158+ # One entry per manual page. List of tuples
159+ # (source start file, name, description, authors, manual section).
160+ man_pages = [
161+ (master_doc , 'oceans' , 'oceans Documentation' ,
162+ [author ], 1 )
163+ ]
164+
165+
166+ # -- Options for Texinfo output ----------------------------------------------
167+
168+ # Grouping the document tree into Texinfo files. List of tuples
169+ # (source start file, target name, title, author,
170+ # dir menu entry, description, category)
171+ texinfo_documents = [
172+ (master_doc , 'oceans' , 'oceans Documentation' ,
173+ author , 'oceans' , 'One line description of project.' ,
174+ 'Miscellaneous' ),
175+ ]
176+
177+
178+ # -- Options for Epub output -------------------------------------------------
179+
180+ # Bibliographic Dublin Core info.
181+ epub_title = project
182+
183+ # The unique identifier of the text. This can be a ISBN number
184+ # or the project homepage.
185+ #
186+ # epub_identifier = ''
187+
188+ # A unique identification for the text.
189+ #
190+ # epub_uid = ''
191+
192+ # A list of files that should not be packed into the epub file.
193+ epub_exclude_files = ['search.html' ]
194+
195+
196+ # -- Extension configuration -------------------------------------------------
0 commit comments