conf.py 7.6 KB

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