conf.py 8.2 KB

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