LCDGFX LCD display driver  1.0.5
This library is developed to control SSD1306/SSD1325/SSD1327/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays
conf.py
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # LCDGFX LCD display driver documentation build configuration file, created by
5 # sphinx-quickstart on Mon May 11 14:34:13 2020.
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 
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 #
20 # import os
21 # import sys
22 # sys.path.insert(0, os.path.abspath('.'))
23 
24 
25 # -- General configuration ------------------------------------------------
26 
27 # If your documentation needs a minimal Sphinx version, state it here.
28 #
29 # needs_sphinx = '1.0'
30 
31 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33 # ones.
34 extensions = []
35 
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['.templates']
38 
39 # The suffix(es) of source filenames.
40 # You can specify multiple suffix as a list of string:
41 #
42 # source_suffix = ['.rst', '.md']
43 source_suffix = ['.md', ".h"]
44 
45 # The master toctree document.
46 master_doc = 'README'
47 
48 # General information about the project.
49 project = 'LCDGFX'
50 copyright = '2020, Alexey Dynda'
51 author = 'Alexey Dynda'
52 
53 # The version info for the project you're documenting, acts as replacement for
54 # |version| and |release|, also used in various other places throughout the
55 # built documents.
56 #
57 # The short X.Y version.
58 version = '1.0.3'
59 # The full version, including alpha/beta/rc tags.
60 release = '1.0.3'
61 
62 # The language for content autogenerated by Sphinx. Refer to documentation
63 # for a list of supported languages.
64 #
65 # This is also used if you do content translation via gettext catalogs.
66 # Usually you set "language" from the command line for these cases.
67 language = cpp
68 
69 # List of patterns, relative to source directory, that match files and
70 # directories to ignore when looking for source files.
71 # This patterns also effect to html_static_path and html_extra_path
72 exclude_patterns = []
73 
74 # The name of the Pygments (syntax highlighting) style to use.
75 pygments_style = 'sphinx'
76 
77 # If true, `todo` and `todoList` produce output, else they produce nothing.
78 todo_include_todos = False
79 
80 
81 # -- Options for HTML output ----------------------------------------------
82 
83 # The theme to use for HTML and HTML Help pages. See the documentation for
84 # a list of builtin themes.
85 #
86 html_theme = 'alabaster'
87 
88 # Theme options are theme-specific and customize the look and feel of a theme
89 # further. For a list of options available for each theme, see the
90 # documentation.
91 #
92 # html_theme_options = {}
93 
94 # Add any paths that contain custom static files (such as style sheets) here,
95 # relative to this directory. They are copied after the builtin static files,
96 # so a file named "default.css" will overwrite the builtin "default.css".
97 html_static_path = ['.static']
98 
99 # Custom sidebar templates, must be a dictionary that maps document names
100 # to template names.
101 #
102 # This is required for the alabaster theme
103 # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
104 html_sidebars = {
105  '**': [
106  'relations.html', # needs 'show_related': True theme option to display
107  'searchbox.html',
108  ]
109 }
110 
111 
112 # -- Options for HTMLHelp output ------------------------------------------
113 
114 # Output file base name for HTML help builder.
115 htmlhelp_basename = 'index'
116 
117 
118 # -- Options for LaTeX output ---------------------------------------------
119 
120 latex_elements = {
121  # The paper size ('letterpaper' or 'a4paper').
122  #
123  # 'papersize': 'letterpaper',
124 
125  # The font size ('10pt', '11pt' or '12pt').
126  #
127  # 'pointsize': '10pt',
128 
129  # Additional stuff for the LaTeX preamble.
130  #
131  # 'preamble': '',
132 
133  # Latex figure (float) alignment
134  #
135  # 'figure_align': 'htbp',
136 }
137 
138 # Grouping the document tree into LaTeX files. List of tuples
139 # (source start file, target name, title,
140 # author, documentclass [howto, manual, or own class]).
141 latex_documents = [
142  (master_doc, 'LCDGFXLCDdisplaydriver.tex', 'LCDGFX LCD display driver Documentation',
143  'Alexey Dynda', 'manual'),
144 ]
145 
146 
147 # -- Options for manual page output ---------------------------------------
148 
149 # One entry per manual page. List of tuples
150 # (source start file, name, description, authors, manual section).
151 man_pages = [
152  (master_doc, 'lcdgfxlcddisplaydriver', 'LCDGFX LCD display driver Documentation',
153  [author], 1)
154 ]
155 
156 
157 # -- Options for Texinfo output -------------------------------------------
158 
159 # Grouping the document tree into Texinfo files. List of tuples
160 # (source start file, target name, title, author,
161 # dir menu entry, description, category)
162 texinfo_documents = [
163  (master_doc, 'LCDGFXLCDdisplaydriver', 'LCDGFX LCD display driver Documentation',
164  author, 'LCDGFXLCDdisplaydriver', 'One line description of project.',
165  'Miscellaneous'),
166 ]
167 
168 
169