conf.py 9.6 KB

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