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

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

Preliminary implementation of a NEMO Quick Start Guide via RST files and Sphinx installation

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 = ''
28# The full version, including alpha/beta/rc tags
29release = '4.0'
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 = [
42]
43
44# Add any paths that contain templates here, relative to this directory.
45templates_path = ['_templates']
46
47# The suffix(es) of source filenames.
48# You can specify multiple suffix as a list of string:
49#
50# source_suffix = ['.rst', '.md']
51source_suffix = '.rst'
52
53# The master toctree document.
54master_doc = 'NEMO_guide'
55
56# The language for content autogenerated by Sphinx. Refer to documentation
57# for a list of supported languages.
58#
59# This is also used if you do content translation via gettext catalogs.
60# Usually you set "language" from the command line for these cases.
61language = None
62
63# List of patterns, relative to source directory, that match files and
64# directories to ignore when looking for source files.
65# This pattern also affects html_static_path and html_extra_path .
66exclude_patterns = []
67
68# The name of the Pygments (syntax highlighting) style to use.
69pygments_style = 'sphinx'
70
71
72# -- Options for HTML output -------------------------------------------------
73
74# The theme to use for HTML and HTML Help pages.  See the documentation for
75# a list of builtin themes.
76#
77html_theme = 'alabaster'
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    'logo': 'NEMO_grey.png',
85    'description': 'Community ocean model for multifarious space and time scales',
86    'fixed_sidebar': 'true',
87#    'github_user': 'NEMO-ocean',
88#    'github_repo': 'NEMO-examples',
89#    'github_button': 'true',
90#    'github_banner': 'true'
91}
92
93# Add any paths that contain custom static files (such as style sheets) here,
94# relative to this directory. They are copied after the builtin static files,
95# so a file named "default.css" will overwrite the builtin "default.css".
96html_static_path = ['_static']
97
98# Custom sidebar templates, must be a dictionary that maps document names
99# to template names.
100#
101# The default sidebars (for documents that don't match any pattern) are
102# defined by theme itself.  Builtin themes are using these templates by
103# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
104# 'searchbox.html']``.
105#
106# html_sidebars = {}
107
108html_favicon = '_static/ORCA.ico'
109
110# -- Options for HTMLHelp output ---------------------------------------------
111
112# Output file base name for HTML help builder.
113htmlhelp_basename = 'NEMOdoc'
114
115
116# -- Options for LaTeX output ------------------------------------------------
117
118latex_elements = {
119    # The paper size ('letterpaper' or 'a4paper').
120    #
121    # 'papersize': 'letterpaper',
122
123    # The font size ('10pt', '11pt' or '12pt').
124    #
125    # 'pointsize': '10pt',
126
127    # Additional stuff for the LaTeX preamble.
128    #
129    # 'preamble': '',
130
131    # Latex figure (float) alignment
132    #
133    # 'figure_align': 'htbp',
134}
135
136# Grouping the document tree into LaTeX files. List of tuples
137# (source start file, target name, title,
138#  author, documentclass [howto, manual, or own class]).
139latex_documents = [
140    (master_doc, 'NEMO_guide.tex', 'NEMO Quick Start Guide',
141     'NEMO System Team', 'howto'),
142]
143
144
145# -- Options for manual page output ------------------------------------------
146
147# One entry per manual page. List of tuples
148# (source start file, name, description, authors, manual section).
149man_pages = [
150    (master_doc, 'nemo', 'NEMO Documentation',
151     [author], 1)
152]
153
154
155# -- Options for Texinfo output ----------------------------------------------
156
157# Grouping the document tree into Texinfo files. List of tuples
158# (source start file, target name, title, author,
159#  dir menu entry, description, category)
160texinfo_documents = [
161    (master_doc, 'NEMO', 'NEMO Documentation',
162     author, 'NEMO', 'One line description of project.',
163     'Miscellaneous'),
164]
Note: See TracBrowser for help on using the repository browser.