conf.py 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. #
  4. # Gluon documentation build configuration file, created by
  5. # sphinx-quickstart on Wed Jan 29 00:45:53 2014.
  6. #
  7. # This file is execfile()d with the current directory set to its
  8. # containing dir.
  9. #
  10. # Note that not all possible configuration values are present in this
  11. # autogenerated file.
  12. #
  13. # All configuration values have a default; values that are commented out
  14. # serve to show the default.
  15. import sys
  16. import os
  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.mathjax',
  29. ]
  30. # Add any paths that contain templates here, relative to this directory.
  31. templates_path = ['_templates']
  32. # The suffix of source filenames.
  33. source_suffix = '.rst'
  34. # The encoding of source files.
  35. #source_encoding = 'utf-8-sig'
  36. # The master toctree document.
  37. master_doc = 'index'
  38. # General information about the project.
  39. project = 'Gluon'
  40. copyright = '2015, Project Gluon'
  41. # The version info for the project you're documenting, acts as replacement for
  42. # |version| and |release|, also used in various other places throughout the
  43. # built documents.
  44. #
  45. # The short X.Y version.
  46. version = '2015.1+'
  47. # The full version, including alpha/beta/rc tags.
  48. release = '2015.1+'
  49. # The language for content autogenerated by Sphinx. Refer to documentation
  50. # for a list of supported languages.
  51. #language = None
  52. # There are two options for replacing |today|: either, you set today to some
  53. # non-false value, then it is used:
  54. #today = ''
  55. # Else, today_fmt is used as the format for a strftime call.
  56. #today_fmt = '%B %d, %Y'
  57. # List of patterns, relative to source directory, that match files and
  58. # directories to ignore when looking for source files.
  59. exclude_patterns = ['_build']
  60. # The reST default role (used for this markup: `text`) to use for all
  61. # documents.
  62. #default_role = None
  63. # If true, '()' will be appended to :func: etc. cross-reference text.
  64. #add_function_parentheses = True
  65. # If true, the current module name will be prepended to all description
  66. # unit titles (such as .. function::).
  67. #add_module_names = True
  68. # If true, sectionauthor and moduleauthor directives will be shown in the
  69. # output. They are ignored by default.
  70. #show_authors = False
  71. # The name of the Pygments (syntax highlighting) style to use.
  72. pygments_style = 'sphinx'
  73. # A list of ignored prefixes for module index sorting.
  74. #modindex_common_prefix = []
  75. # If true, keep warnings as "system message" paragraphs in the built documents.
  76. #keep_warnings = False
  77. # -- Options for HTML output ----------------------------------------------
  78. # The theme to use for HTML and HTML Help pages. See the documentation for
  79. # a list of builtin themes.
  80. #html_theme = 'default'
  81. # Theme options are theme-specific and customize the look and feel of a theme
  82. # further. For a list of options available for each theme, see the
  83. # documentation.
  84. #html_theme_options = {}
  85. # Add any paths that contain custom themes here, relative to this directory.
  86. #html_theme_path = []
  87. # The name for this set of Sphinx documents. If None, it defaults to
  88. # "<project> v<release> documentation".
  89. #html_title = None
  90. # A shorter title for the navigation bar. Default is the same as html_title.
  91. #html_short_title = None
  92. # The name of an image file (relative to this directory) to place at the top
  93. # of the sidebar.
  94. #html_logo = None
  95. # The name of an image file (within the static path) to use as favicon of the
  96. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  97. # pixels large.
  98. #html_favicon = None
  99. # Add any paths that contain custom static files (such as style sheets) here,
  100. # relative to this directory. They are copied after the builtin static files,
  101. # so a file named "default.css" will overwrite the builtin "default.css".
  102. #html_static_path = ['_static']
  103. # Add any extra paths that contain custom files (such as robots.txt or
  104. # .htaccess) here, relative to this directory. These files are copied
  105. # directly to the root of the documentation.
  106. #html_extra_path = []
  107. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  108. # using the given strftime format.
  109. #html_last_updated_fmt = '%b %d, %Y'
  110. # If true, SmartyPants will be used to convert quotes and dashes to
  111. # typographically correct entities.
  112. #html_use_smartypants = True
  113. # Custom sidebar templates, maps document names to template names.
  114. #html_sidebars = {}
  115. # Additional templates that should be rendered to pages, maps page names to
  116. # template names.
  117. #html_additional_pages = {}
  118. # If false, no module index is generated.
  119. #html_domain_indices = True
  120. # If false, no index is generated.
  121. #html_use_index = True
  122. # If true, the index is split into individual pages for each letter.
  123. #html_split_index = False
  124. # If true, links to the reST sources are added to the pages.
  125. #html_show_sourcelink = True
  126. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  127. #html_show_sphinx = True
  128. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  129. #html_show_copyright = True
  130. # If true, an OpenSearch description file will be output, and all pages will
  131. # contain a <link> tag referring to it. The value of this option must be the
  132. # base URL from which the finished HTML is served.
  133. #html_use_opensearch = ''
  134. # This is the file name suffix for HTML files (e.g. ".xhtml").
  135. #html_file_suffix = None
  136. # Output file base name for HTML help builder.
  137. htmlhelp_basename = 'Gluondoc'
  138. # -- Options for LaTeX output ---------------------------------------------
  139. latex_elements = {
  140. # The paper size ('letterpaper' or 'a4paper').
  141. #'papersize': 'letterpaper',
  142. # The font size ('10pt', '11pt' or '12pt').
  143. #'pointsize': '10pt',
  144. # Additional stuff for the LaTeX preamble.
  145. #'preamble': '',
  146. }
  147. # Grouping the document tree into LaTeX files. List of tuples
  148. # (source start file, target name, title,
  149. # author, documentclass [howto, manual, or own class]).
  150. latex_documents = [
  151. ('index', 'Gluon.tex', 'Gluon Documentation',
  152. 'Project Gluon', 'manual'),
  153. ]
  154. # The name of an image file (relative to this directory) to place at the top of
  155. # the title page.
  156. #latex_logo = None
  157. # For "manual" documents, if this is true, then toplevel headings are parts,
  158. # not chapters.
  159. #latex_use_parts = False
  160. # If true, show page references after internal links.
  161. #latex_show_pagerefs = False
  162. # If true, show URL addresses after external links.
  163. #latex_show_urls = False
  164. # Documents to append as an appendix to all manuals.
  165. #latex_appendices = []
  166. # If false, no module index is generated.
  167. #latex_domain_indices = True
  168. # -- Options for manual page output ---------------------------------------
  169. # One entry per manual page. List of tuples
  170. # (source start file, name, description, authors, manual section).
  171. man_pages = [
  172. ('index', 'gluon', 'Gluon Documentation',
  173. ['Project Gluon'], 1)
  174. ]
  175. # If true, show URL addresses after external links.
  176. #man_show_urls = False
  177. # -- Options for Texinfo output -------------------------------------------
  178. # Grouping the document tree into Texinfo files. List of tuples
  179. # (source start file, target name, title, author,
  180. # dir menu entry, description, category)
  181. texinfo_documents = [
  182. ('index', 'Gluon', 'Gluon Documentation',
  183. 'Project Gluon', 'Gluon', 'One line description of project.',
  184. 'Miscellaneous'),
  185. ]
  186. # Documents to append as an appendix to all manuals.
  187. #texinfo_appendices = []
  188. # If false, no module index is generated.
  189. #texinfo_domain_indices = True
  190. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  191. #texinfo_show_urls = 'footnote'
  192. # If true, do not generate a @detailmenu in the "Top" node's menu.
  193. #texinfo_no_detailmenu = False