You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

191 lines
5.9 KiB

  1. # -*- coding: utf-8 -*-
  2. #
  3. # Configuration file for the Sphinx documentation builder.
  4. #
  5. # This file does only contain a selection of the most common options. For a
  6. # full list see the documentation:
  7. # http://www.sphinx-doc.org/en/master/config
  8. # -- Path setup --------------------------------------------------------------
  9. # If extensions (or modules to document with autodoc) are in another directory,
  10. # add these directories to sys.path here. If the directory is relative to the
  11. # documentation root, use os.path.abspath to make it absolute, like shown here.
  12. #
  13. # import os
  14. # import sys
  15. # sys.path.insert(0, os.path.abspath('.'))
  16. # -- Project information -----------------------------------------------------
  17. from pkg_resources import get_distribution
  18. project = 'pEpPythonAdapter'
  19. copyright = '2020, Volker Birk, Matthias Heckmann, juga'
  20. author = 'Volker Birk, Matthias Heckmann, juga'
  21. # The full version, including alpha/beta/rc tags
  22. release = get_distribution('pEp').version
  23. # The short X.Y version
  24. version = '.'.join(release.split('.')[:2])
  25. # -- General configuration ---------------------------------------------------
  26. # If your documentation needs a minimal Sphinx version, state it here.
  27. #
  28. # needs_sphinx = '1.0'
  29. # Add any Sphinx extension module names here, as strings. They can be
  30. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  31. # ones.
  32. extensions = [
  33. 'sphinx.ext.autodoc',
  34. 'sphinx.ext.doctest',
  35. 'sphinx.ext.intersphinx',
  36. 'sphinx.ext.todo',
  37. 'sphinx.ext.coverage',
  38. 'sphinx.ext.viewcode',
  39. ]
  40. # Add any paths that contain templates here, relative to this directory.
  41. templates_path = ['_templates']
  42. # The suffix(es) of source filenames.
  43. # You can specify multiple suffix as a list of string:
  44. #
  45. # source_suffix = ['.rst', '.md']
  46. source_suffix = '.rst'
  47. # The master toctree document.
  48. master_doc = 'index'
  49. # The language for content autogenerated by Sphinx. Refer to documentation
  50. # for a list of supported languages.
  51. #
  52. # This is also used if you do content translation via gettext catalogs.
  53. # Usually you set "language" from the command line for these cases.
  54. language = None
  55. # List of patterns, relative to source directory, that match files and
  56. # directories to ignore when looking for source files.
  57. # This pattern also affects html_static_path and html_extra_path.
  58. exclude_patterns = []
  59. # The name of the Pygments (syntax highlighting) style to use.
  60. pygments_style = None
  61. # -- Options for HTML output -------------------------------------------------
  62. # The theme to use for HTML and HTML Help pages. See the documentation for
  63. # a list of builtin themes.
  64. #
  65. html_theme = 'alabaster'
  66. # Theme options are theme-specific and customize the look and feel of a theme
  67. # further. For a list of options available for each theme, see the
  68. # documentation.
  69. #
  70. # html_theme_options = {}
  71. # Add any paths that contain custom static files (such as style sheets) here,
  72. # relative to this directory. They are copied after the builtin static files,
  73. # so a file named "default.css" will overwrite the builtin "default.css".
  74. html_static_path = ['_static']
  75. # Custom sidebar templates, must be a dictionary that maps document names
  76. # to template names.
  77. #
  78. # The default sidebars (for documents that don't match any pattern) are
  79. # defined by theme itself. Builtin themes are using these templates by
  80. # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
  81. # 'searchbox.html']``.
  82. #
  83. # html_sidebars = {}
  84. # -- Options for HTMLHelp output ---------------------------------------------
  85. # Output file base name for HTML help builder.
  86. htmlhelp_basename = 'pEpPythonAdapterdoc'
  87. # -- Options for LaTeX output ------------------------------------------------
  88. latex_elements = {
  89. # The paper size ('letterpaper' or 'a4paper').
  90. #
  91. # 'papersize': 'letterpaper',
  92. # The font size ('10pt', '11pt' or '12pt').
  93. #
  94. # 'pointsize': '10pt',
  95. # Additional stuff for the LaTeX preamble.
  96. #
  97. # 'preamble': '',
  98. # Latex figure (float) alignment
  99. #
  100. # 'figure_align': 'htbp',
  101. }
  102. # Grouping the document tree into LaTeX files. List of tuples
  103. # (source start file, target name, title,
  104. # author, documentclass [howto, manual, or own class]).
  105. latex_documents = [
  106. (master_doc, 'pEpPythonAdapter.tex', 'pEpPythonAdapter Documentation',
  107. '2020, Volker Birk, Matthias Heckmann, juga', 'manual'),
  108. ]
  109. # -- Options for manual page output ------------------------------------------
  110. # One entry per manual page. List of tuples
  111. # (source start file, name, description, authors, manual section).
  112. man_pages = [
  113. (master_doc, 'peppythonadapter', 'pEpPythonAdapter Documentation',
  114. [author], 1)
  115. ]
  116. # -- Options for Texinfo output ----------------------------------------------
  117. # Grouping the document tree into Texinfo files. List of tuples
  118. # (source start file, target name, title, author,
  119. # dir menu entry, description, category)
  120. texinfo_documents = [
  121. (master_doc, 'pEpPythonAdapter', 'pEpPythonAdapter Documentation',
  122. author, 'pEpPythonAdapter', 'One line description of project.',
  123. 'Miscellaneous'),
  124. ]
  125. # -- Options for Epub output -------------------------------------------------
  126. # Bibliographic Dublin Core info.
  127. epub_title = project
  128. # The unique identifier of the text. This can be a ISBN number
  129. # or the project homepage.
  130. #
  131. # epub_identifier = ''
  132. # A unique identification for the text.
  133. #
  134. # epub_uid = ''
  135. # A list of files that should not be packed into the epub file.
  136. epub_exclude_files = ['search.html']
  137. # -- Extension configuration -------------------------------------------------
  138. # -- Options for intersphinx extension ---------------------------------------
  139. # Example configuration for intersphinx: refer to the Python standard library.
  140. intersphinx_mapping = {'https://docs.python.org/': None}
  141. # -- Options for todo extension ----------------------------------------------
  142. # If true, `todo` and `todoList` produce output, else they produce nothing.
  143. todo_include_todos = True