PageRenderTime 47ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/conf.py

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