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.

347 lines
10 KiB

7 years ago
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Hadaly documentation build configuration file, created by
  4. # sphinx-quickstart on Thu Jun 19 03:14:20 2014.
  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 alabaster
  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 = ['alabaster']
  28. # Add any paths that contain templates here, relative to this directory.
  29. templates_path = ['_templates']
  30. # The suffix of source filenames.
  31. source_suffix = '.rst'
  32. # The encoding of source files.
  33. #source_encoding = 'utf-8-sig'
  34. # The master toctree document.
  35. master_doc = 'index'
  36. # General information about the project.
  37. project = u'Hadaly'
  38. copyright = u'2014, octogene'
  39. # The version info for the project you're documenting, acts as replacement for
  40. # |version| and |release|, also used in various other places throughout the
  41. # built documents.
  42. #
  43. # The short X.Y version.
  44. version = '0.1'
  45. # The full version, including alpha/beta/rc tags.
  46. release = '0.1a1'
  47. # The language for content autogenerated by Sphinx. Refer to documentation
  48. # for a list of supported languages.
  49. language = 'en'
  50. locale_dirs = ['locale/'] # path is example but recommended.
  51. gettext_compact = False
  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 = 'alabaster'
  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. 'logo': 'logo/logo_2.png',
  86. 'logo_name': True,
  87. 'logo_text_align': 'align-center',
  88. 'github_button': False,
  89. 'github_banner': True,
  90. 'github_user': 'octogene',
  91. 'github_repo': 'hadaly',
  92. }
  93. # Add any paths that contain custom themes here, relative to this directory.
  94. html_theme_path = [alabaster.get_path()]
  95. # The name for this set of Sphinx documents. If None, it defaults to
  96. # "<project> v<release> documentation".
  97. #html_title = None
  98. # A shorter title for the navigation bar. Default is the same as html_title.
  99. #html_short_title = None
  100. # The name of an image file (relative to this directory) to place at the top
  101. # of the sidebar.
  102. #html_logo = None
  103. # The name of an image file (within the static path) to use as favicon of the
  104. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  105. # pixels large.
  106. #html_favicon = None
  107. # Add any paths that contain custom static files (such as style sheets) here,
  108. # relative to this directory. They are copied after the builtin static files,
  109. # so a file named "default.css" will overwrite the builtin "default.css".
  110. html_static_path = ['_static']
  111. # Add any extra paths that contain custom files (such as robots.txt or
  112. # .htaccess) here, relative to this directory. These files are copied
  113. # directly to the root of the documentation.
  114. #html_extra_path = []
  115. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  116. # using the given strftime format.
  117. #html_last_updated_fmt = '%b %d, %Y'
  118. # If true, SmartyPants will be used to convert quotes and dashes to
  119. # typographically correct entities.
  120. #html_use_smartypants = True
  121. # Custom sidebar templates, maps document names to template names.
  122. html_sidebars = {
  123. '**': [
  124. 'about.html',
  125. 'navigation.html',
  126. 'relations.html',
  127. 'donate.html',
  128. ]
  129. }
  130. # Additional templates that should be rendered to pages, maps page names to
  131. # template names.
  132. #html_additional_pages = {}
  133. # If false, no module index is generated.
  134. #html_domain_indices = True
  135. # If false, no index is generated.
  136. #html_use_index = True
  137. # If true, the index is split into individual pages for each letter.
  138. #html_split_index = False
  139. # If true, links to the reST sources are added to the pages.
  140. #html_show_sourcelink = True
  141. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  142. #html_show_sphinx = True
  143. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  144. #html_show_copyright = True
  145. # If true, an OpenSearch description file will be output, and all pages will
  146. # contain a <link> tag referring to it. The value of this option must be the
  147. # base URL from which the finished HTML is served.
  148. #html_use_opensearch = ''
  149. # This is the file name suffix for HTML files (e.g. ".xhtml").
  150. #html_file_suffix = None
  151. # Output file base name for HTML help builder.
  152. htmlhelp_basename = 'Hadalydoc'
  153. # -- Options for LaTeX output ---------------------------------------------
  154. latex_elements = {
  155. # The paper size ('letterpaper' or 'a4paper').
  156. #'papersize': 'letterpaper',
  157. # The font size ('10pt', '11pt' or '12pt').
  158. #'pointsize': '10pt',
  159. # Additional stuff for the LaTeX preamble.
  160. #'preamble': '',
  161. }
  162. # Grouping the document tree into LaTeX files. List of tuples
  163. # (source start file, target name, title,
  164. # author, documentclass [howto, manual, or own class]).
  165. latex_documents = [
  166. ('index', 'Hadaly.tex', u'Hadaly Documentation',
  167. u'octogene', 'manual'),
  168. ]
  169. # The name of an image file (relative to this directory) to place at the top of
  170. # the title page.
  171. #latex_logo = None
  172. # For "manual" documents, if this is true, then toplevel headings are parts,
  173. # not chapters.
  174. #latex_use_parts = False
  175. # If true, show page references after internal links.
  176. #latex_show_pagerefs = False
  177. # If true, show URL addresses after external links.
  178. #latex_show_urls = False
  179. # Documents to append as an appendix to all manuals.
  180. #latex_appendices = []
  181. # If false, no module index is generated.
  182. #latex_domain_indices = True
  183. # -- Options for manual page output ---------------------------------------
  184. # One entry per manual page. List of tuples
  185. # (source start file, name, description, authors, manual section).
  186. man_pages = [
  187. ('index', 'hadaly', u'Hadaly Documentation',
  188. [u'octogene'], 1)
  189. ]
  190. # If true, show URL addresses after external links.
  191. #man_show_urls = False
  192. # -- Options for Texinfo output -------------------------------------------
  193. # Grouping the document tree into Texinfo files. List of tuples
  194. # (source start file, target name, title, author,
  195. # dir menu entry, description, category)
  196. texinfo_documents = [
  197. ('index', 'Hadaly', u'Hadaly Documentation',
  198. u'octogene', 'Hadaly', 'One line description of project.',
  199. 'Miscellaneous'),
  200. ]
  201. # Documents to append as an appendix to all manuals.
  202. #texinfo_appendices = []
  203. # If false, no module index is generated.
  204. #texinfo_domain_indices = True
  205. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  206. #texinfo_show_urls = 'footnote'
  207. # If true, do not generate a @detailmenu in the "Top" node's menu.
  208. #texinfo_no_detailmenu = False
  209. # -- Options for Epub output ----------------------------------------------
  210. # Bibliographic Dublin Core info.
  211. epub_title = u'Hadaly'
  212. epub_author = u'octogene'
  213. epub_publisher = u'octogene'
  214. epub_copyright = u'2014, octogene'
  215. # The basename for the epub file. It defaults to the project name.
  216. #epub_basename = u'Hadaly'
  217. # The HTML theme for the epub output. Since the default themes are not optimized
  218. # for small screen space, using the same theme for HTML and epub output is
  219. # usually not wise. This defaults to 'epub', a theme designed to save visual
  220. # space.
  221. #epub_theme = 'epub'
  222. # The language of the text. It defaults to the language option
  223. # or en if the language is not set.
  224. #epub_language = ''
  225. # The scheme of the identifier. Typical schemes are ISBN or URL.
  226. #epub_scheme = ''
  227. # The unique identifier of the text. This can be a ISBN number
  228. # or the project homepage.
  229. #epub_identifier = ''
  230. # A unique identification for the text.
  231. #epub_uid = ''
  232. # A tuple containing the cover image and cover page html template filenames.
  233. #epub_cover = ()
  234. # A sequence of (type, uri, title) tuples for the guide element of content.opf.
  235. #epub_guide = ()
  236. # HTML files that should be inserted before the pages created by sphinx.
  237. # The format is a list of tuples containing the path and title.
  238. #epub_pre_files = []
  239. # HTML files shat should be inserted after the pages created by sphinx.
  240. # The format is a list of tuples containing the path and title.
  241. #epub_post_files = []
  242. # A list of files that should not be packed into the epub file.
  243. epub_exclude_files = ['search.html']
  244. # The depth of the table of contents in toc.ncx.
  245. #epub_tocdepth = 3
  246. # Allow duplicate toc entries.
  247. #epub_tocdup = True
  248. # Choose between 'default' and 'includehidden'.
  249. #epub_tocscope = 'default'
  250. # Fix unsupported image types using the PIL.
  251. #epub_fix_images = False
  252. # Scale large images.
  253. #epub_max_image_width = 0
  254. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  255. #epub_show_urls = 'inline'
  256. # If false, no index is generated.
  257. #epub_use_index = True