conf.py 8.3 KB

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