conf.py 9.0 KB

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