conf.py 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. #
  4. # dnspython documentation build configuration file, created by
  5. # sphinx-quickstart on Fri Dec 30 05:55:44 2016.
  6. #
  7. # This file is execfile()d with the current directory set to its
  8. # containing dir.
  9. #
  10. # Note that not all possible configuration values are present in this
  11. # autogenerated file.
  12. #
  13. # All configuration values have a default; values that are commented out
  14. # serve to show the default.
  15. # If extensions (or modules to document with autodoc) are in another directory,
  16. # add these directories to sys.path here. If the directory is relative to the
  17. # documentation root, use os.path.abspath to make it absolute, like shown here.
  18. #
  19. import os
  20. import sys
  21. sys.path.insert(0, os.path.abspath('..'))
  22. # -- General configuration ------------------------------------------------
  23. # If your documentation needs a minimal Sphinx version, state it here.
  24. #
  25. # needs_sphinx = '1.0'
  26. # Add any Sphinx extension module names here, as strings. They can be
  27. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  28. # ones.
  29. extensions = ['sphinx.ext.autodoc',
  30. 'sphinx.ext.viewcode',
  31. 'sphinx.ext.githubpages']
  32. # Add any paths that contain templates here, relative to this directory.
  33. templates_path = ['_templates']
  34. # The suffix(es) of source filenames.
  35. # You can specify multiple suffix as a list of string:
  36. #
  37. # source_suffix = ['.rst', '.md']
  38. source_suffix = '.rst'
  39. # The master toctree document.
  40. master_doc = 'index'
  41. # General information about the project.
  42. project = 'dnspython'
  43. copyright = '2016, Nominum, Inc.'
  44. author = 'Nominum, Inc.'
  45. # The version info for the project you're documenting, acts as replacement for
  46. # |version| and |release|, also used in various other places throughout the
  47. # built documents.
  48. #
  49. # The short X.Y version.
  50. version = '1.16'
  51. # The full version, including alpha/beta/rc tags.
  52. release = '1.16.0'
  53. # The language for content autogenerated by Sphinx. Refer to documentation
  54. # for a list of supported languages.
  55. #
  56. # This is also used if you do content translation via gettext catalogs.
  57. # Usually you set "language" from the command line for these cases.
  58. language = None
  59. # List of patterns, relative to source directory, that match files and
  60. # directories to ignore when looking for source files.
  61. # This patterns also effect to html_static_path and html_extra_path
  62. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  63. # The name of the Pygments (syntax highlighting) style to use.
  64. pygments_style = 'sphinx'
  65. # If true, `todo` and `todoList` produce output, else they produce nothing.
  66. todo_include_todos = False
  67. # -- Options for autodoc --------------------------------------------------
  68. autoclass_content = 'both'
  69. # -- Options for HTML output ----------------------------------------------
  70. # The theme to use for HTML and HTML Help pages. See the documentation for
  71. # a list of builtin themes.
  72. #
  73. html_theme = 'alabaster'
  74. # Theme options are theme-specific and customize the look and feel of a theme
  75. # further. For a list of options available for each theme, see the
  76. # documentation.
  77. #
  78. # html_theme_options = {}
  79. # Add any paths that contain custom static files (such as style sheets) here,
  80. # relative to this directory. They are copied after the builtin static files,
  81. # so a file named "default.css" will overwrite the builtin "default.css".
  82. html_static_path = ['_static']
  83. # -- Options for HTMLHelp output ------------------------------------------
  84. # Output file base name for HTML help builder.
  85. htmlhelp_basename = 'dnspythondoc'
  86. # -- Options for LaTeX output ---------------------------------------------
  87. latex_elements = {
  88. # The paper size ('letterpaper' or 'a4paper').
  89. #
  90. # 'papersize': 'letterpaper',
  91. # The font size ('10pt', '11pt' or '12pt').
  92. #
  93. # 'pointsize': '10pt',
  94. # Additional stuff for the LaTeX preamble.
  95. #
  96. # 'preamble': '',
  97. # Latex figure (float) alignment
  98. #
  99. # 'figure_align': 'htbp',
  100. }
  101. # Grouping the document tree into LaTeX files. List of tuples
  102. # (source start file, target name, title,
  103. # author, documentclass [howto, manual, or own class]).
  104. latex_documents = [
  105. (master_doc, 'dnspython.tex', 'dnspython Documentation',
  106. 'Nominum, Inc.', 'manual'),
  107. ]
  108. # -- Options for manual page output ---------------------------------------
  109. # One entry per manual page. List of tuples
  110. # (source start file, name, description, authors, manual section).
  111. man_pages = [
  112. (master_doc, 'dnspython', 'dnspython Documentation',
  113. [author], 1)
  114. ]
  115. # -- Options for Texinfo output -------------------------------------------
  116. # Grouping the document tree into Texinfo files. List of tuples
  117. # (source start file, target name, title, author,
  118. # dir menu entry, description, category)
  119. texinfo_documents = [
  120. (master_doc, 'dnspython', 'dnspython Documentation',
  121. author, 'dnspython', 'One line description of project.',
  122. 'Miscellaneous'),
  123. ]