2
0

conf.py 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  1. # -*- coding: utf-8 -*-
  2. #
  3. # dulwich documentation build configuration file, created by
  4. # sphinx-quickstart on Thu Feb 18 23:18:28 2010.
  5. #
  6. # This file is execfile()d with the current directory set to its containing
  7. # dir.
  8. #
  9. # Note that not all possible configuration values are present in this
  10. # autogenerated file.
  11. #
  12. # All configuration values have a default; values that are commented out
  13. # serve to show the default.
  14. import os
  15. import sys
  16. # If extensions (or modules to document with autodoc) are in another directory,
  17. # add these directories to sys.path here. If the directory is relative to the
  18. # documentation root, use os.path.abspath to make it absolute, like shown here.
  19. sys.path.insert(0, os.path.abspath('..'))
  20. sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__))))
  21. dulwich = __import__('dulwich')
  22. # -- General configuration ----------------------------------------------------
  23. # Add any Sphinx extension module names here, as strings. They can be
  24. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  25. extensions = [
  26. 'sphinx.ext.autodoc',
  27. 'sphinx.ext.ifconfig',
  28. 'sphinx.ext.intersphinx',
  29. 'sphinx.ext.napoleon',
  30. ]
  31. autoclass_content = "both"
  32. # Add any paths that contain templates here, relative to this directory.
  33. templates_path = ['templates']
  34. # The suffix of source filenames.
  35. source_suffix = '.txt'
  36. # The encoding of source files.
  37. # source_encoding = 'utf-8'
  38. # The master toctree document.
  39. master_doc = 'index'
  40. # General information about the project.
  41. project = u'dulwich'
  42. copyright = u'2011-2019 Jelmer Vernooij'
  43. # The version info for the project you're documenting, acts as replacement for
  44. # |version| and |release|, also used in various other places throughout the
  45. # built documents.
  46. #
  47. # The short X.Y version.
  48. version = '.'.join(map(str, dulwich.__version__[:2]))
  49. # The full version, including alpha/beta/rc tags.
  50. release = '.'.join(map(str, dulwich.__version__))
  51. # The language for content autogenerated by Sphinx. Refer to documentation
  52. # for a list of supported languages.
  53. # language = None
  54. # There are two options for replacing |today|: either, you set today to some
  55. # non-false value, then it is used:
  56. # today = ''
  57. # Else, today_fmt is used as the format for a strftime call.
  58. # today_fmt = '%B %d, %Y'
  59. # List of documents that shouldn't be included in the build.
  60. # unused_docs = []
  61. # List of directories, relative to source directory, that shouldn't be searched
  62. # for source files.
  63. exclude_trees = ['build']
  64. # The reST default role (used for this markup: `text`) to use for all
  65. # documents.
  66. # default_role = None
  67. # If true, '()' will be appended to :func: etc. cross-reference text.
  68. # add_function_parentheses = True
  69. # If true, the current module name will be prepended to all description
  70. # unit titles (such as .. function::).
  71. # add_module_names = True
  72. # If true, sectionauthor and moduleauthor directives will be shown in the
  73. # output. They are ignored by default.
  74. # show_authors = False
  75. # The name of the Pygments (syntax highlighting) style to use.
  76. pygments_style = 'sphinx'
  77. # A list of ignored prefixes for module index sorting.
  78. # modindex_common_prefix = []
  79. # -- Options for HTML output -------------------------------------------------
  80. # The theme to use for HTML and HTML Help pages. Major themes that come with
  81. # Sphinx are currently 'default' and 'sphinxdoc'.
  82. # html_theme = 'default'
  83. html_theme = 'agogo'
  84. # Theme options are theme-specific and customize the look and feel of a theme
  85. # further. For a list of options available for each theme, see the
  86. # documentation.
  87. # html_theme_options = {}
  88. # Add any paths that contain custom themes here, relative to this directory.
  89. html_theme_path = ['theme']
  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 = []
  106. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  107. # using the given strftime format.
  108. # html_last_updated_fmt = '%b %d, %Y'
  109. # If true, SmartyPants will be used to convert quotes and dashes to
  110. # typographically correct entities.
  111. # html_use_smartypants = True
  112. # Custom sidebar templates, maps document names to template names.
  113. # html_sidebars = {}
  114. # Additional templates that should be rendered to pages, maps page names to
  115. # template names.
  116. # html_additional_pages = {}
  117. # If false, no module index is generated.
  118. # html_use_modindex = True
  119. # If false, no index is generated.
  120. # html_use_index = True
  121. # If true, the index is split into individual pages for each letter.
  122. # html_split_index = False
  123. # If true, links to the reST sources are added to the pages.
  124. # html_show_sourcelink = True
  125. # If true, an OpenSearch description file will be output, and all pages will
  126. # contain a <link> tag referring to it. The value of this option must be the
  127. # base URL from which the finished HTML is served.
  128. # html_use_opensearch = ''
  129. # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  130. # html_file_suffix = ''
  131. # Output file base name for HTML help builder.
  132. htmlhelp_basename = 'dulwichdoc'
  133. # -- Options for LaTeX output ------------------------------------------------
  134. # The paper size ('letter' or 'a4').
  135. # latex_paper_size = 'letter'
  136. # The font size ('10pt', '11pt' or '12pt').
  137. # latex_font_size = '10pt'
  138. # Grouping the document tree into LaTeX files. List of tuples
  139. # (source start file, target name, title, author, documentclass
  140. # [howto/manual]).
  141. latex_documents = [
  142. ('index', 'dulwich.tex', u'dulwich Documentation',
  143. 'Jelmer Vernooij', 'manual'),
  144. ]
  145. # The name of an image file (relative to this directory) to place at the top of
  146. # the title page.
  147. # latex_logo = None
  148. # For "manual" documents, if this is true, then toplevel headings are parts,
  149. # not chapters.
  150. # latex_use_parts = False
  151. # Additional stuff for the LaTeX preamble.
  152. # latex_preamble = ''
  153. # Documents to append as an appendix to all manuals.
  154. # latex_appendices = []
  155. # If false, no module index is generated.
  156. # latex_use_modindex = True
  157. # Add mappings
  158. intersphinx_mapping = {
  159. 'urllib3': ('http://urllib3.readthedocs.org/en/latest', None),
  160. 'python': ('http://docs.python.org/3', None),
  161. }