conf.py 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. #
  4. # BeeWatch documentation build configuration file, created by
  5. # sphinx-quickstart on Fri Mar 24 15:11:40 2017.
  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. import sphinx_rtd_theme
  23. # -- General configuration ------------------------------------------------
  24. # If your documentation needs a minimal Sphinx version, state it here.
  25. #
  26. # needs_sphinx = '1.0'
  27. # Add any Sphinx extension module names here, as strings. They can be
  28. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  29. # ones.
  30. extensions = [
  31. 'sphinx.ext.autodoc',
  32. 'sphinx.ext.intersphinx',
  33. 'sphinx.ext.todo',
  34. ]
  35. # Add any paths that contain templates here, relative to this directory.
  36. templates_path = ['templates']
  37. # The suffix(es) of source filenames.
  38. # You can specify multiple suffix as a list of string:
  39. #
  40. # source_suffix = ['.rst', '.md']
  41. source_suffix = '.rst'
  42. # The master toctree document.
  43. master_doc = 'index'
  44. # General information about the project.
  45. project = 'BeeWatch'
  46. copyright = '2017, Digital'
  47. author = 'Digital'
  48. # The version info for the project you're documenting, acts as replacement for
  49. # |version| and |release|, also used in various other places throughout the
  50. # built documents.
  51. #
  52. # The short X.Y version.
  53. version = 'unreleased'
  54. # The full version, including alpha/beta/rc tags.
  55. release = 'unreleased'
  56. # The language for content autogenerated by Sphinx. Refer to documentation
  57. # for a list of supported languages.
  58. #
  59. # This is also used if you do content translation via gettext catalogs.
  60. # Usually you set "language" from the command line for these cases.
  61. language = None
  62. # List of patterns, relative to source directory, that match files and
  63. # directories to ignore when looking for source files.
  64. # This patterns also effect to html_static_path and html_extra_path
  65. exclude_patterns = []
  66. # The name of the Pygments (syntax highlighting) style to use.
  67. pygments_style = 'sphinx'
  68. # If true, `todo` and `todoList` produce output, else they produce nothing.
  69. todo_include_todos = True
  70. # -- Options for HTML output ----------------------------------------------
  71. # The theme to use for HTML and HTML Help pages. See the documentation for
  72. # a list of builtin themes.
  73. #
  74. html_theme = 'sphinx_rtd_theme'
  75. # Theme options are theme-specific and customize the look and feel of a theme
  76. # further. For a list of options available for each theme, see the
  77. # documentation.
  78. #
  79. # html_theme_options = {}
  80. # Add any paths that contain custom static files (such as style sheets) here,
  81. # relative to this directory. They are copied after the builtin static files,
  82. # so a file named "default.css" will overwrite the builtin "default.css".
  83. html_static_path = ['static']
  84. # -- Options for HTMLHelp output ------------------------------------------
  85. # Output file base name for HTML help builder.
  86. htmlhelp_basename = 'BeeWatchdoc'
  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, 'BeeWatch.tex', 'BeeWatch Documentation',
  107. 'Digital', '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, 'beewatch', 'BeeWatch 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, 'BeeWatch', 'BeeWatch Documentation',
  122. author, 'BeeWatch', 'One line description of project.',
  123. 'Miscellaneous'),
  124. ]
  125. # Example configuration for intersphinx: refer to the Python standard library.
  126. intersphinx_mapping = {'https://docs.python.org/': None}