latex/conf.py
Go to the documentation of this file.
1 # -*- coding: utf-8 -*-
2 #
3 # EusLisp documentation build configuration file, created by
4 # sphinx-quickstart on Mon Jun 10 14:01:34 2019.
5 #
6 # This file is execfile()d with the current directory set to its
7 # containing dir.
8 #
9 # Note that not all possible configuration values are present in this
10 # autogenerated file.
11 #
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
14 
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
18 #
19 # import os
20 # import sys
21 # sys.path.insert(0, os.path.abspath('.'))
22 
23 import subprocess, os, sys
24 def sh(command):
25  print("+ {}".format(command))
26  print(subprocess.check_output(command, shell=True))
27 
28 on_rtd = os.environ.get('READTHEDOCS') == 'True'
29 if on_rtd:
30  # run make rst
31  sh("make rst")
32 
33 # -- General configuration ------------------------------------------------
34 
35 # If your documentation needs a minimal Sphinx version, state it here.
36 #
37 # needs_sphinx = '1.0'
38 
39 # Add any Sphinx extension module names here, as strings. They can be
40 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
41 # ones.
42 extensions = []
43 
44 # Add any paths that contain templates here, relative to this directory.
45 templates_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']
51 source_suffix = '.rst'
52 
53 # The master toctree document.
54 master_doc = 'manual'
55 
56 # General information about the project.
57 project = u'EusLisp'
58 copyright = u'1984-2001, National Institute of Advanced Industrial Science and Technology (AIST)'
59 author = u'Toshihiro Matsui'
60 
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
63 # built documents.
64 #
65 # The short X.Y version.
66 version = u'9.26'
67 # The full version, including alpha/beta/rc tags.
68 release = u'9.26'
69 
70 # The language for content autogenerated by Sphinx. Refer to documentation
71 # for a list of supported languages.
72 #
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.
75 language = None
76 
77 # List of patterns, relative to source directory, that match files and
78 # directories to ignore when looking for source files.
79 # This patterns also effect to html_static_path and html_extra_path
80 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
81 
82 # The name of the Pygments (syntax highlighting) style to use.
83 pygments_style = 'sphinx'
84 
85 # If true, `todo` and `todoList` produce output, else they produce nothing.
86 todo_include_todos = False
87 
88 
89 # -- Options for HTML output ----------------------------------------------
90 
91 # The theme to use for HTML and HTML Help pages. See the documentation for
92 # a list of builtin themes.
93 #
94 html_theme = 'sphinx_rtd_theme'
95 
96 # Theme options are theme-specific and customize the look and feel of a theme
97 # further. For a list of options available for each theme, see the
98 # documentation.
99 #
100 # html_theme_options = {}
101 
102 # Add any paths that contain custom static files (such as style sheets) here,
103 # relative to this directory. They are copied after the builtin static files,
104 # so a file named "default.css" will overwrite the builtin "default.css".
105 html_static_path = ['_static']
106 
107 # Custom sidebar templates, must be a dictionary that maps document names
108 # to template names.
109 #
110 # This is required for the alabaster theme
111 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
112 html_sidebars = {
113  '**': [
114  'relations.html', # needs 'show_related': True theme option to display
115  'searchbox.html',
116  ]
117 }
118 
119 import sphinx_rtd_theme
120 if on_rtd:
121  # The theme to use for HTML and HTML Help pages. See the documentation for
122  # a list of builtin themes.
123  html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
124  sh("sed -i 's@set suffix@set suffix_bak@' {}/sphinx_rtd_theme/breadcrumbs.html".format(html_theme_path[0]))
125 
126  # Add Edit on GitHub link
127  html_context = {
128  'suffix': '.tex',
129  }
130 
131  sh("mkdir -p _build/html")
132  sh("cd _build/html; ln -sf manual.html index.html; ls -al")
133 
134 
135 
136 # -- Options for HTMLHelp output ------------------------------------------
137 
138 # Output file base name for HTML help builder.
139 htmlhelp_basename = 'EusLispdoc'
140 
141 
142 # -- Options for LaTeX output ---------------------------------------------
143 
144 latex_elements = {
145  # The paper size ('letterpaper' or 'a4paper').
146  #
147  # 'papersize': 'letterpaper',
148 
149  # The font size ('10pt', '11pt' or '12pt').
150  #
151  # 'pointsize': '10pt',
152 
153  # Additional stuff for the LaTeX preamble.
154  #
155  # 'preamble': '',
156 
157  # Latex figure (float) alignment
158  #
159  # 'figure_align': 'htbp',
160 }
161 
162 # Grouping the document tree into LaTeX files. List of tuples
163 # (source start file, target name, title,
164 # author, documentclass [howto, manual, or own class]).
165 latex_documents = [
166  (master_doc, 'EusLisp.tex', u'EusLisp Documentation',
167  u'Toshihiro Matsui', 'manual'),
168 ]
169 
170 
171 # -- Options for manual page output ---------------------------------------
172 
173 # One entry per manual page. List of tuples
174 # (source start file, name, description, authors, manual section).
175 man_pages = [
176  (master_doc, 'euslisp', u'EusLisp Documentation',
177  [author], 1)
178 ]
179 
180 
181 # -- Options for Texinfo output -------------------------------------------
182 
183 # Grouping the document tree into Texinfo files. List of tuples
184 # (source start file, target name, title, author,
185 # dir menu entry, description, category)
186 texinfo_documents = [
187  (master_doc, 'EusLisp', u'EusLisp Documentation',
188  author, 'EusLisp', 'EusLisp is an integrated programming system for the research on intelligent robots based on Common Lisp and Object-Oriented programming.',
189  'Miscellaneous'),
190 ]
191 
conf.sh
def sh(command)
Definition: html/conf.py:4


euslisp
Author(s): Toshihiro Matsui
autogenerated on Thu Jun 15 2023 02:06:43