New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
conf.py in NEMO/trunk/doc/rst/source – NEMO

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

Last change on this file since 10593 was 10590, checked in by nicolasmartin, 5 years ago

Shrink sphinx conf file and publish CONTRIBUTING file

File size: 3.2 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# -- Project information -----------------------------------------------------
10
11project = 'NEMO'
12author = 'NEMO System Team'
13
14# The short X.Y version
15version = '4.0'
16# The full version, including alpha/beta/rc tags
17release = '4.0.0'
18
19
20# -- General configuration ---------------------------------------------------
21
22# Add any Sphinx extension module names here, as strings. They can be
23# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
24# ones.
25extensions = ['sphinx.ext.extlinks', 'sphinxcontrib.bibtex']
26
27# The master toctree document.
28master_doc = 'NEMO_guide'
29
30# List of patterns, relative to source directory, that match files and
31# directories to ignore when looking for source files.
32# This pattern also affects html_static_path and html_extra_path .
33exclude_patterns = ['global.rst', 'coarsening.rst']
34
35# The name of the Pygments (syntax highlighting) style to use.
36pygments_style = 'sphinx'
37
38
39# -- Options for HTML output -------------------------------------------------
40
41# The theme to use for HTML and HTML Help pages.  See the documentation for
42# a list of builtin themes.
43#
44html_theme = 'sphinx_rtd_theme'
45
46# Theme options are theme-specific and customize the look and feel of a theme
47# further.  For a list of options available for each theme, see the
48# documentation.
49#
50html_theme_options = {}
51
52# Add any paths that contain custom static files (such as style sheets) here,
53# relative to this directory. They are copied after the builtin static files,
54# so a file named "default.css" will overwrite the builtin "default.css".
55html_static_path = ['_static']
56
57html_favicon = '_static/ORCA.ico'
58
59
60# -- Options for LaTeX output ------------------------------------------------
61
62latex_elements = {
63    # The paper size ('letterpaper' or 'a4paper').
64    #
65    # 'papersize': 'letterpaper',
66
67    # The font size ('10pt', '11pt' or '12pt').
68    #
69    # 'pointsize': '10pt',
70
71    # Additional stuff for the LaTeX preamble.
72    #
73    # 'preamble': '',
74
75    # Latex figure (float) alignment
76    #
77    # 'figure_align': 'htbp',
78}
79
80# Grouping the document tree into LaTeX files. List of tuples
81# (source start file, target name, title,
82#  author, documentclass [howto, manual, or own class]).
83latex_documents = [
84    (master_doc, 'NEMO_guide.tex', 'NEMO Quick Start Guide',
85     'NEMO System Team', 'howto'),
86]
87
88
89# -- Customisation -----------------------------------------------------------
90
91import datetime
92year = datetime.date.today().year
93copyright = '2008-' + str( year ) + ', NEMO Consortium'
94
95# Link aliases
96extlinks = {
97   'doi'    : ('https://doi.org/%s'                       , None),
98   'forge'  : ('https://forge.ipsl.jussieu.fr/nemo/%s'    , None),
99   'github' : ('https://github.com/%s'                    , None),
100   'xios'   : ('https://forge.ipsl.jussieu.fr/ioserver/%s', None),
101   'website': ('https://www.nemo-ocean.eu/%s'             , None),
102   'zenodo' : ('https://zenodo.org/publication/%s'        , None)
103}
104
105# Include common directives for every rst file
106rst_epilog = open('global.rst', 'r').read()
Note: See TracBrowser for help on using the repository browser.