conf.py 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. # -*- coding: utf-8 -*-
  2. #
  3. # alphasign documentation build configuration file, created by
  4. # sphinx-quickstart on Mon Mar 16 00:39:41 2009.
  5. #
  6. # This file is execfile()d with the current directory set to its containing dir.
  7. #
  8. # The contents of this file are pickled, so don't put values in the namespace
  9. # that aren't pickleable (module imports are okay, they're removed automatically).
  10. #
  11. # Note that not all possible configuration values are present in this
  12. # autogenerated file.
  13. #
  14. # All configuration values have a default; values that are commented out
  15. # serve to show the default.
  16. import sys, os
  17. sys.path.append("..")
  18. import alphasign
  19. # If your extensions are in another directory, add it here. If the directory
  20. # is relative to the documentation root, use os.path.abspath to make it
  21. # absolute, like shown here.
  22. #sys.path.append(os.path.abspath('.'))
  23. # General configuration
  24. # ---------------------
  25. # Add any Sphinx extension module names here, as strings. They can be extensions
  26. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  27. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
  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'
  34. # The master toctree document.
  35. master_doc = 'index'
  36. # General information about the project.
  37. project = u'alphasign'
  38. copyright = u'2009, Matt Sparks'
  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 = '1.0'
  45. # The full version, including alpha/beta/rc tags.
  46. release = '1.0'
  47. # The language for content autogenerated by Sphinx. Refer to documentation
  48. # for a list of supported languages.
  49. #language = None
  50. # There are two options for replacing |today|: either, you set today to some
  51. # non-false value, then it is used:
  52. #today = ''
  53. # Else, today_fmt is used as the format for a strftime call.
  54. #today_fmt = '%B %d, %Y'
  55. # List of documents that shouldn't be included in the build.
  56. #unused_docs = []
  57. # List of directories, relative to source directory, that shouldn't be searched
  58. # for source files.
  59. exclude_trees = ['_build']
  60. # The reST default role (used for this markup: `text`) to use for all documents.
  61. #default_role = None
  62. # If true, '()' will be appended to :func: etc. cross-reference text.
  63. #add_function_parentheses = True
  64. # If true, the current module name will be prepended to all description
  65. # unit titles (such as .. function::).
  66. #add_module_names = True
  67. # If true, sectionauthor and moduleauthor directives will be shown in the
  68. # output. They are ignored by default.
  69. #show_authors = False
  70. # The name of the Pygments (syntax highlighting) style to use.
  71. pygments_style = 'sphinx'
  72. # Options for HTML output
  73. # -----------------------
  74. # The style sheet to use for HTML and HTML Help pages. A file of that name
  75. # must exist either in Sphinx' static/ path, or in one of the custom paths
  76. # given in html_static_path.
  77. html_style = 'default.css'
  78. # The name for this set of Sphinx documents. If None, it defaults to
  79. # "<project> v<release> documentation".
  80. #html_title = None
  81. # A shorter title for the navigation bar. Default is the same as html_title.
  82. #html_short_title = None
  83. # The name of an image file (relative to this directory) to place at the top
  84. # of the sidebar.
  85. #html_logo = None
  86. # The name of an image file (within the static path) to use as favicon of the
  87. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  88. # pixels large.
  89. #html_favicon = None
  90. # Add any paths that contain custom static files (such as style sheets) here,
  91. # relative to this directory. They are copied after the builtin static files,
  92. # so a file named "default.css" will overwrite the builtin "default.css".
  93. html_static_path = ['_static']
  94. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  95. # using the given strftime format.
  96. #html_last_updated_fmt = '%b %d, %Y'
  97. # If true, SmartyPants will be used to convert quotes and dashes to
  98. # typographically correct entities.
  99. #html_use_smartypants = True
  100. # Custom sidebar templates, maps document names to template names.
  101. #html_sidebars = {}
  102. # Additional templates that should be rendered to pages, maps page names to
  103. # template names.
  104. #html_additional_pages = {}
  105. # If false, no module index is generated.
  106. #html_use_modindex = True
  107. # If false, no index is generated.
  108. #html_use_index = True
  109. # If true, the index is split into individual pages for each letter.
  110. #html_split_index = False
  111. # If true, the reST sources are included in the HTML build as _sources/<name>.
  112. #html_copy_source = True
  113. # If true, an OpenSearch description file will be output, and all pages will
  114. # contain a <link> tag referring to it. The value of this option must be the
  115. # base URL from which the finished HTML is served.
  116. #html_use_opensearch = ''
  117. # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  118. #html_file_suffix = ''
  119. # Output file base name for HTML help builder.
  120. htmlhelp_basename = 'alphasigndoc'
  121. # Options for LaTeX output
  122. # ------------------------
  123. # The paper size ('letter' or 'a4').
  124. #latex_paper_size = 'letter'
  125. # The font size ('10pt', '11pt' or '12pt').
  126. #latex_font_size = '10pt'
  127. # Grouping the document tree into LaTeX files. List of tuples
  128. # (source start file, target name, title, author, document class [howto/manual]).
  129. latex_documents = [
  130. ('index', 'alphasign.tex', ur'alphasign Documentation',
  131. ur'Matt Sparks', 'manual'),
  132. ]
  133. # The name of an image file (relative to this directory) to place at the top of
  134. # the title page.
  135. #latex_logo = None
  136. # For "manual" documents, if this is true, then toplevel headings are parts,
  137. # not chapters.
  138. #latex_use_parts = False
  139. # Additional stuff for the LaTeX preamble.
  140. #latex_preamble = ''
  141. # Documents to append as an appendix to all manuals.
  142. #latex_appendices = []
  143. # If false, no module index is generated.
  144. #latex_use_modindex = True
  145. # autodoc config
  146. autoclass_content = "both"