conf.py 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. # -*- coding: utf-8 -*-
  2. #
  3. # pysaml2 documentation build configuration file, created by
  4. # sphinx-quickstart on Mon Aug 24 08:13:41 2009.
  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. from __future__ import unicode_literals
  14. import os
  15. import alabaster
  16. import saml2.version
  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.append(os.path.abspath('.'))
  21. # -- General configuration -----------------------------------------------------
  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', 'sphinx.ext.doctest', 'sphinx.ext.coverage']
  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'
  31. # The master toctree document.
  32. master_doc = 'index'
  33. # General information about the project.
  34. project = 'pysaml2'
  35. copyright = '2010-2011, Roland Hedberg'
  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 = str(saml2.version.version)
  42. # The full version, including alpha/beta/rc tags.
  43. release = ''
  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 documents that shouldn't be included in the build.
  53. #unused_docs = []
  54. # List of directories, relative to source directory, that shouldn't be searched
  55. # for source files.
  56. exclude_trees = ['_build']
  57. # The reST default role (used for this markup: `text`) to use for all documents.
  58. #default_role = None
  59. # If true, '()' will be appended to :func: etc. cross-reference text.
  60. #add_function_parentheses = True
  61. # If true, the current module name will be prepended to all description
  62. # unit titles (such as .. function::).
  63. #add_module_names = True
  64. # If true, sectionauthor and moduleauthor directives will be shown in the
  65. # output. They are ignored by default.
  66. #show_authors = False
  67. # The name of the Pygments (syntax highlighting) style to use.
  68. pygments_style = 'sphinx'
  69. # A list of ignored prefixes for module index sorting.
  70. #modindex_common_prefix = []
  71. # -- Options for HTML output ---------------------------------------------------
  72. # The theme to use for HTML and HTML Help pages. Major themes that come with
  73. # Sphinx are currently 'default' and 'sphinxdoc'.
  74. html_theme_path = [alabaster.get_path()]
  75. html_theme = 'alabaster'
  76. on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
  77. if on_rtd: # only import and set the theme if we're building docs locally
  78. html_theme = 'sphinx_rtd_theme'
  79. # Theme options are theme-specific and customize the look and feel of a theme
  80. # further. For a list of options available for each theme, see the
  81. # documentation.
  82. #html_theme_options = {}
  83. # Add any paths that contain custom themes here, relative to this directory.
  84. #html_theme_path = []
  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 = None
  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_use_modindex = 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, 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. # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  125. #html_file_suffix = ''
  126. # Output file base name for HTML help builder.
  127. htmlhelp_basename = 'pysaml2doc'
  128. # -- Options for LaTeX output --------------------------------------------------
  129. # The paper size ('letter' or 'a4').
  130. #latex_paper_size = 'letter'
  131. # The font size ('10pt', '11pt' or '12pt').
  132. #latex_font_size = '10pt'
  133. # Grouping the document tree into LaTeX files. List of tuples
  134. # (source start file, target name, title, author, documentclass [howto/manual]).
  135. latex_documents = [
  136. (
  137. 'index',
  138. 'pysaml2.tex',
  139. 'pysaml2 Documentation',
  140. 'Roland Hedberg',
  141. 'manual',
  142. ),
  143. ]
  144. # The name of an image file (relative to this directory) to place at the top of
  145. # the title page.
  146. #latex_logo = None
  147. # For "manual" documents, if this is true, then toplevel headings are parts,
  148. # not chapters.
  149. #latex_use_parts = False
  150. # Additional stuff for the LaTeX preamble.
  151. #latex_preamble = ''
  152. # Documents to append as an appendix to all manuals.
  153. #latex_appendices = []
  154. # If false, no module index is generated.
  155. #latex_use_modindex = True