conf.py 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. # -*- coding: utf-8 -*-
  2. #
  3. # luma.led_matrix documentation build configuration file, created by
  4. # sphinx-quickstart on Wed Mar 11 23:24:05 2015.
  5. #
  6. # This file is execfile()d with the current directory set to its
  7. # containing 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. from datetime import datetime
  17. # If extensions (or modules to document with autodoc) are in another directory,
  18. # add these directories to sys.path here. If the directory is relative to the
  19. # documentation root, use os.path.abspath to make it absolute, like shown here.
  20. sys.path.insert(0, os.path.abspath('..'))
  21. from luma.led_matrix import __version__ as version
  22. # -- General configuration ------------------------------------------------
  23. # If your documentation needs a minimal Sphinx version, state it here.
  24. #needs_sphinx = '1.0'
  25. # Add any Sphinx extension module names here, as strings. They can be
  26. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  27. # ones.
  28. extensions = [
  29. 'sphinx.ext.autodoc',
  30. 'sphinx.ext.doctest',
  31. 'sphinx.ext.intersphinx',
  32. 'sphinx.ext.autosectionlabel',
  33. 'sphinx.ext.todo',
  34. 'sphinx.ext.coverage',
  35. 'sphinx.ext.ifconfig',
  36. 'sphinx.ext.viewcode',
  37. 'sphinx.ext.inheritance_diagram',
  38. 'sphinx.ext.extlinks'
  39. ]
  40. # Add any paths that contain templates here, relative to this directory.
  41. templates_path = ['_templates']
  42. # The suffix of source filenames.
  43. source_suffix = '.rst'
  44. # The encoding of source files.
  45. #source_encoding = 'utf-8-sig'
  46. # The master toctree document.
  47. master_doc = 'index'
  48. # General information about the project.
  49. project = u'Luma.LED_Matrix: Display driver for MAX7219, WS2812'
  50. author = u'Richard Hull and contributors'
  51. copyright = u'2015-{0}, {1}'.format(datetime.now().year, author)
  52. # The version info for the project you're documenting, acts as replacement for
  53. # |version| and |release|, also used in various other places throughout the
  54. # built documents.
  55. # The full version, including alpha/beta/rc tags.
  56. release = version
  57. # The language for content autogenerated by Sphinx. Refer to documentation
  58. # for a list of supported languages.
  59. #language = None
  60. # There are two options for replacing |today|: either, you set today to some
  61. # non-false value, then it is used:
  62. #today = ''
  63. # Else, today_fmt is used as the format for a strftime call.
  64. #today_fmt = '%B %d, %Y'
  65. # List of patterns, relative to source directory, that match files and
  66. # directories to ignore when looking for source files.
  67. exclude_patterns = ['_build']
  68. # The reST default role (used for this markup: `text`) to use for all
  69. # documents.
  70. #default_role = None
  71. # If true, '()' will be appended to :func: etc. cross-reference text.
  72. #add_function_parentheses = True
  73. # If true, the current module name will be prepended to all description
  74. # unit titles (such as .. function::).
  75. #add_module_names = True
  76. # If true, sectionauthor and moduleauthor directives will be shown in the
  77. # output. They are ignored by default.
  78. #show_authors = False
  79. # The name of the Pygments (syntax highlighting) style to use.
  80. pygments_style = 'sphinx'
  81. # A list of ignored prefixes for module index sorting.
  82. #modindex_common_prefix = []
  83. # If true, keep warnings as "system message" paragraphs in the built documents.
  84. #keep_warnings = False
  85. # -- Options for HTML output ----------------------------------------------
  86. # The theme to use for HTML and HTML Help pages. See the documentation for
  87. # a list of builtin themes.
  88. html_theme = 'default'
  89. # Theme options are theme-specific and customize the look and feel of a theme
  90. # further. For a list of options available for each theme, see the
  91. # documentation.
  92. #html_theme_options = {}
  93. # Add any paths that contain custom themes here, relative to this directory.
  94. #html_theme_path = []
  95. # The name for this set of Sphinx documents. If None, it defaults to
  96. # "<project> v<release> documentation".
  97. #html_title = None
  98. # A shorter title for the navigation bar. Default is the same as html_title.
  99. #html_short_title = None
  100. # The name of an image file (relative to this directory) to place at the top
  101. # of the sidebar.
  102. #html_logo = None
  103. # The name of an image file (within the static path) to use as favicon of the
  104. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  105. # pixels large.
  106. #html_favicon = None
  107. # Add any paths that contain custom static files (such as style sheets) here,
  108. # relative to this directory. They are copied after the builtin static files,
  109. # so a file named "default.css" will overwrite the builtin "default.css".
  110. # html_static_path = ['_static']
  111. # Add any extra paths that contain custom files (such as robots.txt or
  112. # .htaccess) here, relative to this directory. These files are copied
  113. # directly to the root of the documentation.
  114. #html_extra_path = []
  115. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  116. # using the given strftime format.
  117. #html_last_updated_fmt = '%b %d, %Y'
  118. # If true, SmartyPants will be used to convert quotes and dashes to
  119. # typographically correct entities.
  120. #html_use_smartypants = True
  121. # Custom sidebar templates, maps document names to template names.
  122. #html_sidebars = {}
  123. # Additional templates that should be rendered to pages, maps page names to
  124. # template names.
  125. #html_additional_pages = {}
  126. # If false, no module index is generated.
  127. #html_domain_indices = True
  128. # If false, no index is generated.
  129. #html_use_index = True
  130. # If true, the index is split into individual pages for each letter.
  131. #html_split_index = False
  132. # If true, links to the reST sources are added to the pages.
  133. #html_show_sourcelink = True
  134. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  135. #html_show_sphinx = True
  136. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  137. #html_show_copyright = True
  138. # If true, an OpenSearch description file will be output, and all pages will
  139. # contain a <link> tag referring to it. The value of this option must be the
  140. # base URL from which the finished HTML is served.
  141. #html_use_opensearch = ''
  142. # This is the file name suffix for HTML files (e.g. ".xhtml").
  143. #html_file_suffix = None
  144. # Output file base name for HTML help builder.
  145. htmlhelp_basename = 'luma.led_matrix_doc'
  146. # -- Options for LaTeX output ---------------------------------------------
  147. latex_elements = {
  148. # The paper size ('letterpaper' or 'a4paper').
  149. #'papersize': 'letterpaper',
  150. # The font size ('10pt', '11pt' or '12pt').
  151. #'pointsize': '10pt',
  152. # Additional stuff for the LaTeX preamble.
  153. #'preamble': '',
  154. }
  155. # Grouping the document tree into LaTeX files. List of tuples
  156. # (source start file, target name, title,
  157. # author, documentclass [howto, manual, or own class]).
  158. latex_documents = [
  159. ('index', 'luma.led_matrix.tex', u'Luma.LED_Matrix Documentation',
  160. author, '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', 'luma.led_matrix', u'Luma.LED_Matrix Documentation',
  181. [author], 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', 'luma.led_matrix', u'Luma.LED_Matrix Documentation',
  191. author, 'luma.led_matrix', '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'
  200. # If true, do not generate a @detailmenu in the "Top" node's menu.
  201. #texinfo_no_detailmenu = False
  202. # Configuration for intersphinx
  203. intersphinx_mapping = {
  204. 'python': ('https://docs.python.org/3', None),
  205. 'pillow': ('https://pillow.readthedocs.io/en/latest', None),
  206. 'luma.core': ('https://luma-core.readthedocs.io/en/latest', None),
  207. 'luma.emulator': ('https://luma-emulator.readthedocs.io/en/latest', None)
  208. }