1 # -*- coding: utf-8 -*-
3 # sat documentation build configuration file, created by
4 # sphinx-quickstart on Fri Apr 13 10:08:59 2018.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
18 # https://stackoverflow.com/questions/23462494/how-to-add-a-custom-css-file-to-sphinx
19 # this needs realpath(custom), cause problem on relocated git clone,
20 # so use file link instead in _themes/alabaster: ln -s ../../../../src/custom.css custom.css
22 # custom = os.path.join('src', 'custom.css')
23 # print "setup add_stylesheet\n %s as\n %s" % (custom, os.path.realpath(custom))
24 # app.add_stylesheet(os.path.realpath(custom))
26 # If extensions (or modules to document with autodoc) are in another directory,
27 # add these directories to sys.path here. If the directory is relative to the
28 # documentation root, use os.path.abspath to make it absolute, like shown here.
29 #sys.path.insert(0, os.path.abspath('.'))
31 # -- General configuration -----------------------------------------------------
33 # If your documentation needs a minimal Sphinx version, state it here.
36 # Add any Sphinx extension module names here, as strings. They can be extensions
37 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
38 extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.viewcode']
40 # do not use rst_prolog please use doc/rst_prolog.rst and '.. include:: ../rst_prolog.rst'
41 # https://github.com/sphinx-doc/sphinx/issues/2445
43 # Add any paths that contain templates here, relative to this directory.
44 templates_path = ['_templates']
46 # The suffix of source filenames.
47 source_suffix = '.rst'
49 # The encoding of source files.
50 #source_encoding = 'utf-8-sig'
52 # The master toctree document.
55 # General information about the project.
57 copyright = u'2019, CEA'
59 # The version info for the project you're documenting, acts as replacement for
60 # |version| and |release|, also used in various other places throughout the
63 # The short X.Y version.
65 # The full version, including alpha/beta/rc tags.
68 # The language for content autogenerated by Sphinx. Refer to documentation
69 # for a list of supported languages.
72 # There are two options for replacing |today|: either, you set today to some
73 # non-false value, then it is used:
75 # Else, today_fmt is used as the format for a strftime call.
76 #today_fmt = '%B %d, %Y'
78 # List of patterns, relative to source directory, that match files and
79 # directories to ignore when looking for source files.
82 # The reST default role (used for this markup: `text`) to use for all documents.
85 # If true, '()' will be appended to :func: etc. cross-reference text.
86 #add_function_parentheses = True
88 # If true, the current module name will be prepended to all description
89 # unit titles (such as .. function::).
90 #add_module_names = True
92 # If true, sectionauthor and moduleauthor directives will be shown in the
93 # output. They are ignored by default.
96 # The name of the Pygments (syntax highlighting) style to use.
97 pygments_style = 'sphinx'
99 # A list of ignored prefixes for module index sorting.
100 #modindex_common_prefix = []
103 # -- Options for HTML output ---------------------------------------------------
105 # The theme to use for HTML and HTML Help pages. See the documentation for
106 # a list of builtin themes.
107 # default sphinxdoc scrolls agogo traditional nature haiku
108 html_theme = 'alabaster' #added in _theme dir
110 # Theme options are theme-specific and customize the look and feel of a theme
111 # further. For a list of options available for each theme, see the
113 html_theme_options = {
115 #'github_user': 'bitprophet',
116 #'github_repo': 'alabaster',
117 #'description': 'MYYY DESCRIPTION',
118 #'sidebar_includehidden': True,
119 #'sidebar_collapse': True,
120 #'show_powered_by': False,
121 'show_related': True,
122 'fixed_sidebar': False,
123 'page_width': '1000px',
124 'sidebar_width': '250px',
125 'font_size': '0.9em', #'1.0625em',
126 'code_font_size': '0.8em',
128 'pre_bg': '#fee', # code-block background
134 # Add any paths that contain custom themes here, relative to this directory.
135 html_theme_path = ["../_themes/alabaster", ]
137 # The name for this set of Sphinx documents. If None, it defaults to
138 # "<project> v<release> documentation".
141 # A shorter title for the navigation bar. Default is the same as html_title.
142 #html_short_title = None
144 # The name of an image file (relative to this directory) to place at the top
146 html_logo = "images/sat_v5.png"
148 # The name of an image file (within the static path) to use as favicon of the
149 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
153 # Add any paths that contain custom static files (such as style sheets) here,
154 # relative to this directory. They are copied after the builtin static files,
155 # so a file named "default.css" will overwrite the builtin "default.css".
156 #html_static_path = ['_static']
158 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
159 # using the given strftime format.
160 #html_last_updated_fmt = '%b %d, %Y'
162 # If true, SmartyPants will be used to convert quotes and dashes to
163 # typographically correct entities.
164 html_use_smartypants = False
166 # Custom sidebar templates, maps document names to template names.
169 # Additional templates that should be rendered to pages, maps page names to
171 #html_additional_pages = {}
173 # If false, no module index is generated.
174 #html_domain_indices = True
176 # If false, no index is generated.
177 #html_use_index = True
179 # If true, the index is split into individual pages for each letter.
180 #html_split_index = False
182 # If true, links to the reST sources are added to the pages.
183 #html_show_sourcelink = True
185 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
186 #html_show_sphinx = True
188 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
189 #html_show_copyright = True
191 # If true, an OpenSearch description file will be output, and all pages will
192 # contain a <link> tag referring to it. The value of this option must be the
193 # base URL from which the finished HTML is served.
194 #html_use_opensearch = ''
196 # This is the file name suffix for HTML files (e.g. ".xhtml").
197 #html_file_suffix = None
199 # Output file base name for HTML help builder.
200 htmlhelp_basename = 'satdoc'
203 # -- Options for LaTeX output --------------------------------------------------
206 # The paper size ('letterpaper' or 'a4paper').
207 'papersize': 'a4paper',
209 # The font size ('10pt', '11pt' or '12pt').
212 # Additional stuff for the LaTeX preamble.
215 # http://www.sphinx-doc.org/en/master/latex.html
216 'sphinxsetup': 'verbatimwithframe=false, VerbatimColor={rgb}{.98,.94,.94}',
220 # The paper size ('letter' or 'a4').
221 #latex_paper_size = 'a4'
223 # The font size ('10pt', '11pt' or '12pt').
224 #latex_font_size = '10pt'
226 # Grouping the document tree into LaTeX files. List of tuples
227 # (source start file, target name, title, author, documentclass [howto/manual]).
229 ('index', 'sat.tex', u'SAT Documentation',
230 u'CEA DES/ISAS/DM2S/STMF/LGLS', 'manual'),
233 # The name of an image file (relative to this directory) to place at the top of
237 # For "manual" documents, if this is true, then toplevel headings are parts,
239 #latex_use_parts = False
241 # If true, show page references after internal links.
242 latex_show_pagerefs = True
244 # If true, show URL addresses after external links.
245 latex_show_urls = 'footnote' # sphinx version 1.7 # True
247 # Additional stuff for the LaTeX preamble.
250 # Documents to append as an appendix to all manuals.
251 #latex_appendices = []
253 # If false, no module index is generated.
254 #latex_domain_indices = True
257 # -- Options for manual page output --------------------------------------------
259 # One entry per manual page. List of tuples
260 # (source start file, name, description, authors, manual section).
262 ('index', 'sat', u'SAT Documentation',
263 [u'CEA DES/ISAS/DM2S/STMF/LGLS'], 1)