source: NEMO/branches/2019/dev_ASINTER-01-05_merged/doc/rst/source/conf.py @ 12165

Last change on this file since 12165 was 12165, checked in by davestorkey, 10 months ago

2019/dev_ASINTER-01-05_merged: Update to r12072 of trunk.

File size: 9.2 KB
Line 
1# -*- coding: utf-8 -*-
2#
3# NEMO documentation build configuration file, created by
4# sphinx-quickstart on Tue Oct 15 20:13:55 2019.
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
14import sys, os
15
16# If extensions (or modules to document with autodoc) are in another directory,
17# add these directories to sys.path here. If the directory is relative to the
18# documentation root, use os.path.abspath to make it absolute, like shown here.
19#sys.path.insert(0, os.path.abspath('.'))
20
21# -- General configuration -----------------------------------------------------
22
23# If your documentation needs a minimal Sphinx version, state it here.
24#needs_sphinx = '1.0'
25
26# Add any Sphinx extension module names here, as strings. They can be extensions
27# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex',
29              'sphinx.ext.todo'    , 'sphinx.ext.autosectionlabel']
30
31# Add any paths that contain templates here, relative to this directory.
32templates_path = ['_templates']
33
34# The suffix of source filenames.
35source_suffix = '.rst'
36
37# The encoding of source files.
38#source_encoding = 'utf-8-sig'
39
40# The master toctree document.
41master_doc = 'guide'
42
43# General information about the project.
44project = u'NEMO'
45copyright = u'2019, NEMO Consortium'
46
47# The version info for the project you're documenting, acts as replacement for
48# |version| and |release|, also used in various other places throughout the
49# built documents.
50#
51# The short X.Y version.
52version = 'trk'
53# The full version, including alpha/beta/rc tags.
54release = 'trunk'
55
56# The language for content autogenerated by Sphinx. Refer to documentation
57# for a list of supported languages.
58#language = None
59
60# There are two options for replacing |today|: either, you set today to some
61# non-false value, then it is used:
62#today = ''
63# Else, today_fmt is used as the format for a strftime call.
64#today_fmt = '%B %d, %Y'
65
66# List of patterns, relative to source directory, that match files and
67# directories to ignore when looking for source files.
68exclude_patterns = ['global.rst', 'readme.rst']
69
70# The reST default role (used for this markup: `text`) to use for all documents.
71#default_role = None
72
73# If true, '()' will be appended to :func: etc. cross-reference text.
74#add_function_parentheses = True
75
76# If true, the current module name will be prepended to all description
77# unit titles (such as .. function::).
78#add_module_names = True
79
80# If true, sectionauthor and moduleauthor directives will be shown in the
81# output. They are ignored by default.
82#show_authors = False
83
84# The name of the Pygments (syntax highlighting) style to use.
85pygments_style = 'emacs'
86
87# A list of ignored prefixes for module index sorting.
88#modindex_common_prefix = []
89
90
91# -- Options for HTML output ---------------------------------------------------
92
93# The theme to use for HTML and HTML Help pages.  See the documentation for
94# a list of builtin themes.
95html_theme = 'sphinx_rtd_theme'
96
97# Theme options are theme-specific and customize the look and feel of a theme
98# further.  For a list of options available for each theme, see the
99# documentation.
100#html_theme_options = {}
101
102# Add any paths that contain custom themes here, relative to this directory.
103#html_theme_path = []
104
105# The name for this set of Sphinx documents.  If None, it defaults to
106# "<project> v<release> documentation".
107#html_title = None
108
109# A shorter title for the navigation bar.  Default is the same as html_title.
110#html_short_title = None
111
112# The name of an image file (relative to this directory) to place at the top
113# of the sidebar.
114#html_logo = None
115
116# The name of an image file (within the static path) to use as favicon of the
117# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
118# pixels large.
119html_favicon = '_static/ORCA.ico'
120
121# Add any paths that contain custom static files (such as style sheets) here,
122# relative to this directory. They are copied after the builtin static files,
123# so a file named "default.css" will overwrite the builtin "default.css".
124html_static_path = ['_static']
125
126# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
127# using the given strftime format.
128#html_last_updated_fmt = '%b %d, %Y'
129
130# If true, SmartyPants will be used to convert quotes and dashes to
131# typographically correct entities.
132#html_use_smartypants = True
133
134# Custom sidebar templates, maps document names to template names.
135#html_sidebars = {}
136
137# Additional templates that should be rendered to pages, maps page names to
138# template names.
139#html_additional_pages = {}
140
141# If false, no module index is generated.
142#html_domain_indices = True
143
144# If false, no index is generated.
145#html_use_index = True
146
147# If true, the index is split into individual pages for each letter.
148#html_split_index = False
149
150# If true, links to the reST sources are added to the pages.
151#html_show_sourcelink = True
152
153# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
154#html_show_sphinx = True
155
156# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
157#html_show_copyright = True
158
159# If true, an OpenSearch description file will be output, and all pages will
160# contain a <link> tag referring to it.  The value of this option must be the
161# base URL from which the finished HTML is served.
162#html_use_opensearch = ''
163
164# This is the file name suffix for HTML files (e.g. ".xhtml").
165#html_file_suffix = None
166
167# Output file base name for HTML help builder.
168htmlhelp_basename = 'NEMOdoc'
169
170
171# -- Options for LaTeX output --------------------------------------------------
172
173latex_elements = {
174# The paper size ('letterpaper' or 'a4paper').
175#'papersize': 'letterpaper',
176
177# The font size ('10pt', '11pt' or '12pt').
178#'pointsize': '10pt',
179
180# Additional stuff for the LaTeX preamble.
181#'preamble': '',
182}
183
184# Grouping the document tree into LaTeX files. List of tuples
185# (source start file, target name, title, author, documentclass [howto/manual]).
186latex_documents = [
187  ('guide', 'guide.tex', u'NEMO Quick Start Guide',
188   u'NEMO Consortium', 'howto'),
189]
190
191# The name of an image file (relative to this directory) to place at the top of
192# the title page.
193#latex_logo = None
194
195# For "manual" documents, if this is true, then toplevel headings are parts,
196# not chapters.
197#latex_use_parts = False
198
199# If true, show page references after internal links.
200#latex_show_pagerefs = False
201
202# If true, show URL addresses after external links.
203#latex_show_urls = False
204
205# Documents to append as an appendix to all manuals.
206#latex_appendices = []
207
208# If false, no module index is generated.
209#latex_domain_indices = True
210
211
212# -- Options for manual page output --------------------------------------------
213
214# One entry per manual page. List of tuples
215# (source start file, name, description, authors, manual section).
216man_pages = [
217    ('guide', 'nemo', u'NEMO Documentation',
218     [u'NEMO System Team'], 1)
219]
220
221# If true, show URL addresses after external links.
222#man_show_urls = False
223
224
225# -- Options for Texinfo output ------------------------------------------------
226
227# Grouping the document tree into Texinfo files. List of tuples
228# (source start file, target name, title, author,
229#  dir menu entry, description, category)
230texinfo_documents = [
231  ('guide', 'NEMO', u'NEMO Documentation',
232   u'NEMO System Team', 'NEMO', 'Community Ocean Model',
233   'Miscellaneous'),
234]
235
236# Documents to append as an appendix to all manuals.
237#texinfo_appendices = []
238
239# If false, no module index is generated.
240#texinfo_domain_indices = True
241
242# How to display URL addresses: 'footnote', 'no', or 'inline'.
243#texinfo_show_urls = 'footnote'
244
245# -- Customisation -------------------------------------------------------------
246
247# Timestamping
248import datetime
249year = datetime.date.today().year
250copyright = '2008-' + str( year ) + ', NEMO Consortium'
251
252# Link aliases
253extlinks = {
254   'doi'    : ('https://doi.org/%s'                                                    , 'doi:'),
255   'manhtml': ('https://forge.ipsl.jussieu.fr/nemo/chrome/site/doc/NEMO/manual/html/%s', None  ),
256   'forge'  : ('https://forge.ipsl.jussieu.fr/nemo/%s'                                 , None  ),
257   'gmd'    : ('https://www.geosci-model-dev.net/%s'                                   , None  ),
258   'github' : ('https://github.com/NEMO-ocean/%s'                                      , None  ),
259   'xios'   : ('https://forge.ipsl.jussieu.fr/ioserver/%s'                             , None  ),
260   'website': ('https://www.nemo-ocean.eu/%s'                                          , None  ),
261   'zenodo' : ('https://zenodo.org/publication/%s'                                     , None  )
262}
263
264# Include common directives for every rst file
265rst_epilog = open('global.rst', 'r').read()
266
267# SVN revision
268import subprocess
269rev = subprocess.check_output("svnversion").decode("utf-8")
270rst_prolog = '.. |revision| replace:: %s' % rev
271
272# 'draft' build tag: DRAFT watermark and TODO list
273if tags.has('draft'):
274   todo_include_todos = True
275   todo_emit_warnings = True
276else:
277   exclude_patterns = ['global.rst', 'readme.rst', 'todos.rst', 'unpub*']
278
279# Default language to highlight set to fortran
280highlight_language = 'fortran'
Note: See TracBrowser for help on using the repository browser.