1 # -*- coding: utf-8 -*-
3 # Ring documentation build configuration file, created by
4 # sphinx-quickstart on Sun May 03 10:07:42 2015.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
19 # If extensions (or modules to document with autodoc) are in another directory,
20 # add these directories to sys.path here. If the directory is relative to the
21 # documentation root, use os.path.abspath to make it absolute, like shown here.
22 #sys.path.insert(0, os.path.abspath('.'))
24 # -- General configuration ------------------------------------------------
26 # If your documentation needs a minimal Sphinx version, state it here.
29 # Add any Sphinx extension module names here, as strings. They can be
30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 # 'sphinx.ext.intersphinx',
36 'sphinx.ext.coverage',
37 # 'sphinx.ext.mathjax',
38 'sphinx.ext.ifconfig',
42 # Add any paths that contain templates here, relative to this directory.
43 templates_path = ['_templates']
45 # The suffix(es) of source filenames.
46 # You can specify multiple suffix as a list of string:
47 # source_suffix = ['.rst', '.md']
48 source_suffix = '.txt'
50 # The encoding of source files.
51 #source_encoding = 'utf-8-sig'
53 # The master toctree document.
56 # General information about the project.
58 copyright = u'2016-2020, Ring Team'
61 # The version info for the project you're documenting, acts as replacement for
62 # |version| and |release|, also used in various other places throughout the
65 # The short X.Y version.
67 # The full version, including alpha/beta/rc tags.
70 # The language for content autogenerated by Sphinx. Refer to documentation
71 # for a list of supported languages.
73 # This is also used if you do content translation via gettext catalogs.
74 # Usually you set "language" from the command line for these cases.
77 # There are two options for replacing |today|: either, you set today to some
78 # non-false value, then it is used:
80 # Else, today_fmt is used as the format for a strftime call.
81 #today_fmt = '%B %d, %Y'
83 # List of patterns, relative to source directory, that match files and
84 # directories to ignore when looking for source files.
87 # The reST default role (used for this markup: `text`) to use for all
91 # If true, '()' will be appended to :func: etc. cross-reference text.
92 #add_function_parentheses = True
94 # If true, the current module name will be prepended to all description
95 # unit titles (such as .. function::).
96 #add_module_names = True
98 # If true, sectionauthor and moduleauthor directives will be shown in the
99 # output. They are ignored by default.
100 #show_authors = False
102 # The name of the Pygments (syntax highlighting) style to use.
103 pygments_style = 'sphinx'
105 # A list of ignored prefixes for module index sorting.
106 #modindex_common_prefix = []
108 # If true, keep warnings as "system message" paragraphs in the built documents.
109 #keep_warnings = False
111 # If true, `todo` and `todoList` produce output, else they produce nothing.
112 todo_include_todos = True
115 # -- Options for HTML output ----------------------------------------------
117 # The theme to use for HTML and HTML Help pages. See the documentation for
118 # a list of builtin themes.
119 #html_theme = 'alabaster'
121 html_theme = "classic"
122 html_theme_options = {
123 "rightsidebar": "true",
124 "relbarbgcolor": "black"
125 # "nosidebar": "true"
128 #html_theme = "sphinx_rtd_theme"
130 # Theme options are theme-specific and customize the look and feel of a theme
131 # further. For a list of options available for each theme, see the
133 #html_theme_options = {}
135 # Add any paths that contain custom themes here, relative to this directory.
136 #html_theme_path = []
138 # The name for this set of Sphinx documents. If None, it defaults to
139 # "<project> v<release> 取扱説明書".
140 html_title = u"プログラミング言語 Ring 1.12 取扱説明書"
142 # A shorter title for the navigation bar. Default is the same as html_title.
143 #html_short_title = None
145 # The name of an image file (relative to this directory) to place at the top
149 # The name of an image file (within the static path) to use as favicon of the
150 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
154 # Add any paths that contain custom static files (such as style sheets) here,
155 # relative to this directory. They are copied after the builtin static files,
156 # so a file named "default.css" will overwrite the builtin "default.css".
157 html_static_path = ['_static']
159 # Add any extra paths that contain custom files (such as robots.txt or
160 # .htaccess) here, relative to this directory. These files are copied
161 # directly to the root of the documentation.
162 #html_extra_path = []
164 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
165 # using the given strftime format.
166 #html_last_updated_fmt = '%b %d, %Y'
168 # If true, SmartyPants will be used to convert quotes and dashes to
169 # typographically correct entities.
170 #html_use_smartypants = True
172 # Custom sidebar templates, maps document names to template names.
175 # Additional templates that should be rendered to pages, maps page names to
177 #html_additional_pages = {}
179 # If false, no module index is generated.
180 #html_domain_indices = True
182 # If false, no index is generated.
183 #html_use_index = True
185 # If true, the index is split into individual pages for each letter.
186 #html_split_index = False
188 # If true, links to the reST sources are added to the pages.
189 #html_show_sourcelink = True
191 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
192 #html_show_sphinx = True
194 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
195 #html_show_copyright = True
197 # If true, an OpenSearch description file will be output, and all pages will
198 # contain a <link> tag referring to it. The value of this option must be the
199 # base URL from which the finished HTML is served.
200 #html_use_opensearch = ''
202 # This is the file name suffix for HTML files (e.g. ".xhtml").
203 #html_file_suffix = None
205 # Language to be used for generating the HTML full-text search index.
206 # Sphinx supports the following languages:
207 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
208 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
209 html_search_language = 'ja'
211 # A dictionary with options for the search language support, empty by default.
212 # Now only 'ja' uses this config value
213 html_search_options = {'type': 'default'}
215 # The name of a javascript file (relative to the configuration directory) that
216 # implements a search results scorer. If empty, the default will be used.
217 #html_search_scorer = 'scorer.js'
219 # Output file base name for HTML help builder.
220 htmlhelp_basename = 'Ringdoc'
222 # -- Options for LaTeX output ---------------------------------------------
225 'classoptions': ',oneside,openany',
226 'babel': '\\usepackage[english]{babel}',
228 # The paper size ('letterpaper' or 'a4paper').
229 #'papersize': 'letterpaper',
231 # The font size ('10pt', '11pt' or '12pt').
232 #'pointsize': '10pt',
234 # Additional stuff for the LaTeX preamble.
237 # Latex figure (float) alignment
238 #'figure_align': 'htbp',
241 # Grouping the document tree into LaTeX files. List of tuples
242 # (source start file, target name, title,
243 # author, documentclass [howto, manual, or own class]).
245 (master_doc, 'Ring.tex', u'Ring 取扱説明書',
246 u'Ring Team', 'manual'),
249 # The name of an image file (relative to this directory) to place at the top of
253 # For "manual" documents, if this is true, then toplevel headings are parts,
255 #latex_use_parts = False
257 # If true, show page references after internal links.
258 #latex_show_pagerefs = False
260 # If true, show URL addresses after external links.
261 #latex_show_urls = False
263 # Documents to append as an appendix to all manuals.
264 #latex_appendices = []
266 # If false, no module index is generated.
267 #latex_domain_indices = True
270 # -- Options for manual page output ---------------------------------------
272 # One entry per manual page. List of tuples
273 # (source start file, name, description, authors, manual section).
275 (master_doc, 'ring', u'Ring 取扱説明書',
279 # If true, show URL addresses after external links.
280 #man_show_urls = False
283 # -- Options for Texinfo output -------------------------------------------
285 # Grouping the document tree into Texinfo files. List of tuples
286 # (source start file, target name, title, author,
287 # dir menu entry, description, category)
288 texinfo_documents = [
289 (master_doc, 'Ring', u'Ring 取扱説明書',
290 author, 'Ring', 'One line description of project.',
294 # Documents to append as an appendix to all manuals.
295 #texinfo_appendices = []
297 # If false, no module index is generated.
298 #texinfo_domain_indices = True
300 # How to display URL addresses: 'footnote', 'no', or 'inline'.
301 #texinfo_show_urls = 'footnote'
303 # If true, do not generate a @detailmenu in the "Top" node's menu.
304 #texinfo_no_detailmenu = False
307 # -- Options for Epub output ----------------------------------------------
309 # Bibliographic Dublin Core info.
310 epub_title = html_title
312 epub_publisher = author
313 epub_copyright = copyright
315 # The basename for the epub file. It defaults to the project name.
316 #epub_basename = project
318 # The HTML theme for the epub output. Since the default themes are not optimized
319 # for small screen space, using the same theme for HTML and epub output is
320 # usually not wise. This defaults to 'epub', a theme designed to save visual
325 epub_theme_options = {
331 # The language of the text. It defaults to the language option
332 # or 'en' if the language is not set.
335 # The scheme of the identifier. Typical schemes are ISBN or URL.
338 # The unique identifier of the text. This can be a ISBN number
339 # or the project homepage.
340 #epub_identifier = ''
342 # A unique identification for the text.
345 # A tuple containing the cover image and cover page html template filenames.
346 epub_cover = ('_static/cover.png', '')
348 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
351 # HTML files that should be inserted before the pages created by sphinx.
352 # The format is a list of tuples containing the path and title.
355 # HTML files shat should be inserted after the pages created by sphinx.
356 # The format is a list of tuples containing the path and title.
357 #epub_post_files = []
359 # A list of files that should not be packed into the epub file.
360 epub_exclude_files = ['search.html']
362 # The depth of the table of contents in toc.ncx.
365 # Allow duplicate toc entries.
368 # Choose between 'default' and 'includehidden'.
369 #epub_tocscope = 'default'
371 # Fix unsupported image types using the Pillow.
372 #epub_fix_images = False
374 # Scale large images.
375 #epub_max_image_width = 0
377 # How to display URL addresses: 'footnote', 'no', or 'inline'.
378 #epub_show_urls = 'inline'
380 # If false, no index is generated.
381 epub_use_index = True
384 # Example configuration for intersphinx: refer to the Python standard library.
385 intersphinx_mapping = {'https://docs.python.org/': None}