source: NEMO/trunk/doc/rst/source/conf.py @ 10460

Last change on this file since 10460 was 10460, checked in by nicolasmartin, 20 months ago

Small modifications regarding README(s) and ReST files

File size: 5.5 KB
Line 
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
22project = 'NEMO'
23copyright = ''
24author = 'NEMO System Team'
25
26# The short X.Y version
27version = '4.0'
28# The full version, including alpha/beta/rc tags
29release = '4.0rc'
30
31
32# -- General configuration ---------------------------------------------------
33
34# If your documentation needs a minimal Sphinx version, state it here.
35#
36# needs_sphinx = '1.0'
37
38# Add any Sphinx extension module names here, as strings. They can be
39# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40# ones.
41extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex']
42
43# Add any paths that contain templates here, relative to this directory.
44templates_path = ['_templates']
45
46# The suffix(es) of source filenames.
47# You can specify multiple suffix as a list of string:
48#
49# source_suffix = ['.rst', '.md']
50source_suffix = '.rst'
51
52# The master toctree document.
53master_doc = 'NEMO_guide'
54
55# The language for content autogenerated by Sphinx. Refer to documentation
56# for a list of supported languages.
57#
58# This is also used if you do content translation via gettext catalogs.
59# Usually you set "language" from the command line for these cases.
60language = None
61
62# List of patterns, relative to source directory, that match files and
63# directories to ignore when looking for source files.
64# This pattern also affects html_static_path and html_extra_path .
65exclude_patterns = ['global.rst', 'coarsening.rst']
66
67# The name of the Pygments (syntax highlighting) style to use.
68pygments_style = 'sphinx'
69
70
71# -- Options for HTML output -------------------------------------------------
72
73# The theme to use for HTML and HTML Help pages.  See the documentation for
74# a list of builtin themes.
75#
76#html_theme = 'alabaster'
77html_theme = 'sphinx_rtd_theme'
78
79# Theme options are theme-specific and customize the look and feel of a theme
80# further.  For a list of options available for each theme, see the
81# documentation.
82#
83html_theme_options = {
84#  Alabaster theme options
85#  'logo': 'NEMO_grey.png',
86#  'description': 'Community ocean model for multifarious space and time scales',
87#  'fixed_sidebar': True,
88}
89
90# Add any paths that contain custom static files (such as style sheets) here,
91# relative to this directory. They are copied after the builtin static files,
92# so a file named "default.css" will overwrite the builtin "default.css".
93html_static_path = ['_static']
94
95# Custom sidebar templates, must be a dictionary that maps document names
96# to template names.
97#
98# The default sidebars (for documents that don't match any pattern) are
99# defined by theme itself.  Builtin themes are using these templates by
100# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
101# 'searchbox.html']``.
102#
103# html_sidebars = {}
104
105html_favicon = '_static/ORCA.ico'
106
107# -- Options for HTMLHelp output ---------------------------------------------
108
109# Output file base name for HTML help builder.
110htmlhelp_basename = 'NEMOdoc'
111
112
113# -- Options for LaTeX output ------------------------------------------------
114
115latex_elements = {
116    # The paper size ('letterpaper' or 'a4paper').
117    #
118    # 'papersize': 'letterpaper',
119
120    # The font size ('10pt', '11pt' or '12pt').
121    #
122    # 'pointsize': '10pt',
123
124    # Additional stuff for the LaTeX preamble.
125    #
126    # 'preamble': '',
127
128    # Latex figure (float) alignment
129    #
130    # 'figure_align': 'htbp',
131}
132
133# Grouping the document tree into LaTeX files. List of tuples
134# (source start file, target name, title,
135#  author, documentclass [howto, manual, or own class]).
136latex_documents = [
137    (master_doc, 'NEMO_guide.tex', 'NEMO Quick Start Guide',
138     'NEMO System Team', 'howto'),
139]
140
141
142# -- Options for manual page output ------------------------------------------
143
144# One entry per manual page. List of tuples
145# (source start file, name, description, authors, manual section).
146man_pages = [
147    (master_doc, 'nemo', 'NEMO Documentation',
148     [author], 1)
149]
150
151
152# -- Options for Texinfo output ----------------------------------------------
153
154# Grouping the document tree into Texinfo files. List of tuples
155# (source start file, target name, title, author,
156#  dir menu entry, description, category)
157texinfo_documents = [
158    (master_doc, 'NEMO', 'NEMO Documentation',
159     author, 'NEMO', 'One line description of project.',
160     'Miscellaneous'),
161]
162
163
164# -- Customisation -----------------------------------------------------------
165
166import datetime
167year = datetime.date.today().year
168copyright = '2008-' + str( year ) + ', NEMO Consortium'
169
170# Link aliases
171extlinks = {
172   'doi'    : ('http://doi.org/%s'                       , None),
173   'forge'  : ('http://forge.ipsl.jussieu.fr/nemo/%s'    , None),
174   'github' : ('http://github.com/%s'                    , None),
175   'xios'   : ('http://forge.ipsl.jussieu.fr/ioserver/%s', None),
176   'website': ('http://www.nemo-ocean.eu/%s'             , None),
177   'zenodo' : ('http://zenodo.org/publication/%s'        , None)
178}
179
180# Include common directives for every rst file
181rst_epilog = open('global.rst', 'r').read()
Note: See TracBrowser for help on using the repository browser.