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

Last change on this file since 10201 was 10201, checked in by nicolasmartin, 2 years ago

Various modifications related to the setting of a NEMO Quick Start Guide

  • Add missing namelist blocks from ICE and TOP
  • Create a hidden .global.rst to gather common URL links
  • Convert animated gif to frames images for PDF export
  • Place different README.rst appropriately in the code structure and refer to them with symbolic links in doc/rst/source
File size: 4.9 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 = '2018, NEMO System Team'
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 = ['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 = []
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#
76html_theme = 'alabaster'
77
78# Theme options are theme-specific and customize the look and feel of a theme
79# further.  For a list of options available for each theme, see the
80# documentation.
81#
82html_theme_options = {
83    'logo': 'NEMO_grey.png',
84    'description': 'Community ocean model for multifarious space and time scales',
85    'fixed_sidebar': 'true',
86#    'github_user': 'NEMO-ocean',
87#    'github_repo': 'NEMO-examples',
88#    'github_button': 'true',
89#    'github_banner': 'true'
90}
91
92# Add any paths that contain custom static files (such as style sheets) here,
93# relative to this directory. They are copied after the builtin static files,
94# so a file named "default.css" will overwrite the builtin "default.css".
95html_static_path = ['_static']
96
97# Custom sidebar templates, must be a dictionary that maps document names
98# to template names.
99#
100# The default sidebars (for documents that don't match any pattern) are
101# defined by theme itself.  Builtin themes are using these templates by
102# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
103# 'searchbox.html']``.
104#
105# html_sidebars = {}
106
107html_favicon = '_static/ORCA.ico'
108
109# -- Options for HTMLHelp output ---------------------------------------------
110
111# Output file base name for HTML help builder.
112htmlhelp_basename = 'NEMOdoc'
113
114
115# -- Options for LaTeX output ------------------------------------------------
116
117latex_elements = {
118    # The paper size ('letterpaper' or 'a4paper').
119    #
120    # 'papersize': 'letterpaper',
121
122    # The font size ('10pt', '11pt' or '12pt').
123    #
124    # 'pointsize': '10pt',
125
126    # Additional stuff for the LaTeX preamble.
127    #
128    # 'preamble': '',
129
130    # Latex figure (float) alignment
131    #
132    # 'figure_align': 'htbp',
133}
134
135# Grouping the document tree into LaTeX files. List of tuples
136# (source start file, target name, title,
137#  author, documentclass [howto, manual, or own class]).
138latex_documents = [
139    (master_doc, 'NEMO_guide.tex', 'NEMO Quick Start Guide',
140     'NEMO System Team', 'howto'),
141]
142
143
144# -- Options for manual page output ------------------------------------------
145
146# One entry per manual page. List of tuples
147# (source start file, name, description, authors, manual section).
148man_pages = [
149    (master_doc, 'nemo', 'NEMO Documentation',
150     [author], 1)
151]
152
153
154# -- Options for Texinfo output ----------------------------------------------
155
156# Grouping the document tree into Texinfo files. List of tuples
157# (source start file, target name, title, author,
158#  dir menu entry, description, category)
159texinfo_documents = [
160    (master_doc, 'NEMO', 'NEMO Documentation',
161     author, 'NEMO', 'One line description of project.',
162     'Miscellaneous'),
163]
Note: See TracBrowser for help on using the repository browser.