The Sol Programming Language!
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

conf.py 9.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Sol documentation build configuration file, created by
  4. # sphinx-quickstart on Mon Oct 19 11:40:28 2015.
  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. import sys
  15. import os
  16. import shlex
  17. # If extensions (or modules to document with autodoc) are in another directory,
  18. # add these directories to sys.path here. If the directory is relative to the
  19. # documentation root, use os.path.abspath to make it absolute, like shown here.
  20. #sys.path.insert(0, os.path.abspath('.'))
  21. # -- General configuration ------------------------------------------------
  22. # If your documentation needs a minimal Sphinx version, state it here.
  23. #needs_sphinx = '1.0'
  24. # Add any Sphinx extension module names here, as strings. They can be
  25. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  26. # ones.
  27. extensions = [
  28. 'sphinx.ext.autodoc',
  29. 'sphinx.ext.todo',
  30. 'sphinx.ext.coverage',
  31. 'sphinx.ext.mathjax',
  32. 'sphinx.ext.viewcode',
  33. 'breathe',
  34. ]
  35. # Add any paths that contain templates here, relative to this directory.
  36. templates_path = ['_templates']
  37. # The suffix(es) of source filenames.
  38. # You can specify multiple suffix as a list of string:
  39. # source_suffix = ['.rst', '.md']
  40. source_suffix = '.rst'
  41. # The encoding of source files.
  42. #source_encoding = 'utf-8-sig'
  43. # The master toctree document.
  44. master_doc = 'doc/index'
  45. # General information about the project.
  46. project = u'Sol'
  47. copyright = u'2015, Grissess et. al.'
  48. author = u'Grissess et. al.'
  49. # The version info for the project you're documenting, acts as replacement for
  50. # |version| and |release|, also used in various other places throughout the
  51. # built documents.
  52. #
  53. # The short X.Y version.
  54. version = '0.1'
  55. # The full version, including alpha/beta/rc tags.
  56. release = '0.1a4'
  57. # Breathe's own information about the project.
  58. breathe_projects = {
  59. project: 'doxyxml/xml',
  60. }
  61. breathe_default_project = project
  62. breathe_projects_souce = {
  63. project: '.',
  64. }
  65. # The language for content autogenerated by Sphinx. Refer to documentation
  66. # for a list of supported languages.
  67. #
  68. # This is also used if you do content translation via gettext catalogs.
  69. # Usually you set "language" from the command line for these cases.
  70. language = None
  71. # There are two options for replacing |today|: either, you set today to some
  72. # non-false value, then it is used:
  73. #today = ''
  74. # Else, today_fmt is used as the format for a strftime call.
  75. #today_fmt = '%B %d, %Y'
  76. # List of patterns, relative to source directory, that match files and
  77. # directories to ignore when looking for source files.
  78. exclude_patterns = ['_build']
  79. # The reST default role (used for this markup: `text`) to use for all
  80. # documents.
  81. default_role = 'any'
  82. # If true, '()' will be appended to :func: etc. cross-reference text.
  83. #add_function_parentheses = True
  84. # If true, the current module name will be prepended to all description
  85. # unit titles (such as .. function::).
  86. #add_module_names = True
  87. # If true, sectionauthor and moduleauthor directives will be shown in the
  88. # output. They are ignored by default.
  89. #show_authors = False
  90. # The name of the Pygments (syntax highlighting) style to use.
  91. pygments_style = 'sphinx'
  92. # A list of ignored prefixes for module index sorting.
  93. #modindex_common_prefix = []
  94. # If true, keep warnings as "system message" paragraphs in the built documents.
  95. #keep_warnings = False
  96. # If true, `todo` and `todoList` produce output, else they produce nothing.
  97. todo_include_todos = True
  98. # -- Options for HTML output ----------------------------------------------
  99. # The theme to use for HTML and HTML Help pages. See the documentation for
  100. # a list of builtin themes.
  101. html_theme = 'alabaster'
  102. # Theme options are theme-specific and customize the look and feel of a theme
  103. # further. For a list of options available for each theme, see the
  104. # documentation.
  105. #html_theme_options = {}
  106. # Add any paths that contain custom themes here, relative to this directory.
  107. #html_theme_path = []
  108. # The name for this set of Sphinx documents. If None, it defaults to
  109. # "<project> v<release> documentation".
  110. #html_title = None
  111. # A shorter title for the navigation bar. Default is the same as html_title.
  112. #html_short_title = None
  113. # The name of an image file (relative to this directory) to place at the top
  114. # of the sidebar.
  115. #html_logo = None
  116. # The name of an image file (within the static path) to use as favicon of the
  117. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  118. # pixels large.
  119. #html_favicon = None
  120. # Add any paths that contain custom static files (such as style sheets) here,
  121. # relative to this directory. They are copied after the builtin static files,
  122. # so a file named "default.css" will overwrite the builtin "default.css".
  123. html_static_path = ['_static']
  124. # Add any extra paths that contain custom files (such as robots.txt or
  125. # .htaccess) here, relative to this directory. These files are copied
  126. # directly to the root of the documentation.
  127. #html_extra_path = []
  128. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  129. # using the given strftime format.
  130. #html_last_updated_fmt = '%b %d, %Y'
  131. # If true, SmartyPants will be used to convert quotes and dashes to
  132. # typographically correct entities.
  133. #html_use_smartypants = True
  134. # Custom sidebar templates, maps document names to template names.
  135. #html_sidebars = {}
  136. # Additional templates that should be rendered to pages, maps page names to
  137. # template names.
  138. #html_additional_pages = {}
  139. # If false, no module index is generated.
  140. #html_domain_indices = True
  141. # If false, no index is generated.
  142. #html_use_index = True
  143. # If true, the index is split into individual pages for each letter.
  144. #html_split_index = False
  145. # If true, links to the reST sources are added to the pages.
  146. #html_show_sourcelink = True
  147. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  148. #html_show_sphinx = True
  149. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  150. #html_show_copyright = True
  151. # If true, an OpenSearch description file will be output, and all pages will
  152. # contain a <link> tag referring to it. The value of this option must be the
  153. # base URL from which the finished HTML is served.
  154. #html_use_opensearch = ''
  155. # This is the file name suffix for HTML files (e.g. ".xhtml").
  156. #html_file_suffix = None
  157. # Language to be used for generating the HTML full-text search index.
  158. # Sphinx supports the following languages:
  159. # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
  160. # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
  161. #html_search_language = 'en'
  162. # A dictionary with options for the search language support, empty by default.
  163. # Now only 'ja' uses this config value
  164. #html_search_options = {'type': 'default'}
  165. # The name of a javascript file (relative to the configuration directory) that
  166. # implements a search results scorer. If empty, the default will be used.
  167. #html_search_scorer = 'scorer.js'
  168. # Output file base name for HTML help builder.
  169. htmlhelp_basename = 'Soldoc'
  170. # -- Options for LaTeX output ---------------------------------------------
  171. latex_elements = {
  172. # The paper size ('letterpaper' or 'a4paper').
  173. #'papersize': 'letterpaper',
  174. # The font size ('10pt', '11pt' or '12pt').
  175. #'pointsize': '10pt',
  176. # Additional stuff for the LaTeX preamble.
  177. #'preamble': '',
  178. # Latex figure (float) alignment
  179. #'figure_align': 'htbp',
  180. }
  181. # Grouping the document tree into LaTeX files. List of tuples
  182. # (source start file, target name, title,
  183. # author, documentclass [howto, manual, or own class]).
  184. latex_documents = [
  185. (master_doc, 'Sol.tex', u'Sol Documentation',
  186. u'Grissess et. al.', 'manual'),
  187. ]
  188. # The name of an image file (relative to this directory) to place at the top of
  189. # the title page.
  190. #latex_logo = None
  191. # For "manual" documents, if this is true, then toplevel headings are parts,
  192. # not chapters.
  193. #latex_use_parts = False
  194. # If true, show page references after internal links.
  195. #latex_show_pagerefs = False
  196. # If true, show URL addresses after external links.
  197. #latex_show_urls = False
  198. # Documents to append as an appendix to all manuals.
  199. #latex_appendices = []
  200. # If false, no module index is generated.
  201. #latex_domain_indices = True
  202. # -- Options for manual page output ---------------------------------------
  203. # One entry per manual page. List of tuples
  204. # (source start file, name, description, authors, manual section).
  205. man_pages = [
  206. (master_doc, 'sol', u'Sol Documentation',
  207. [author], 1)
  208. ]
  209. # If true, show URL addresses after external links.
  210. #man_show_urls = False
  211. # -- Options for Texinfo output -------------------------------------------
  212. # Grouping the document tree into Texinfo files. List of tuples
  213. # (source start file, target name, title, author,
  214. # dir menu entry, description, category)
  215. texinfo_documents = [
  216. (master_doc, 'Sol', u'Sol Documentation',
  217. author, 'Sol', 'One line description of project.',
  218. 'Miscellaneous'),
  219. ]
  220. # Documents to append as an appendix to all manuals.
  221. #texinfo_appendices = []
  222. # If false, no module index is generated.
  223. #texinfo_domain_indices = True
  224. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  225. #texinfo_show_urls = 'footnote'
  226. # If true, do not generate a @detailmenu in the "Top" node's menu.
  227. #texinfo_no_detailmenu = False
  228. # Following are site-local extensions for this project: