conf.py 8.0 KB

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