1  #
  2  # Adafruit_Blinka_rp1pio documentation build configuration file, created by
  3  # sphinx-quickstart on Fri Feb 26 00:29:33 2016.
  4  #
  5  # This file is execfile()d with the current directory set to its
  6  # containing dir.
  7  #
  8  # Note that not all possible configuration values are present in this
  9  # autogenerated file.
 10  #
 11  # All configuration values have a default; values that are commented out
 12  # serve to show the default.
 13  
 14  
 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  # sys.path.insert(0, os.path.abspath('.'))
 19  
 20  # -- General configuration ------------------------------------------------
 21  
 22  # If your documentation needs a minimal Sphinx version, state it here.
 23  # needs_sphinx = '1.0'
 24  
 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.intersphinx",
 31      "sphinx.ext.autosummary",
 32      "sphinx.ext.napoleon",
 33      "myst_parser",
 34  ]
 35  
 36  autosummary_generate = True
 37  
 38  # Add any paths that contain templates here, relative to this directory.
 39  templates_path = ["_templates"]
 40  
 41  # The suffix(es) of source filenames.
 42  # You can specify multiple suffix as a list of string:
 43  # source_suffix = ['.rst', '.md']
 44  source_suffix = {
 45      ".rst": "restructuredtext",
 46      ".txt": "markdown",
 47      ".md": "markdown",
 48  }
 49  
 50  # The encoding of source files.
 51  # source_encoding = 'utf-8-sig'
 52  
 53  # The master toctree document.
 54  master_doc = "index"
 55  
 56  # General information about the project.
 57  project = "Adafruit Blinka Raspberry Pi5 rp1pio"
 58  copyright = "2024 Jeff Epler for Adafruit Industries"
 59  author = "Jeff Epler for Adafruit Industries"
 60  
 61  # The version info for the project you're documenting, acts as replacement for
 62  # |version| and |release|, also used in various other places throughout the
 63  # built documents.
 64  #
 65  import setuptools_scm  # noqa: E402
 66  
 67  # The full version, including alpha/beta/rc tags.
 68  release = setuptools_scm.get_version("..")
 69  # The short X.Y version.
 70  version = release.split("+")[0]
 71  del setuptools_scm
 72  
 73  # The language for content autogenerated by Sphinx. Refer to documentation
 74  # for a list of supported languages.
 75  #
 76  # This is also used if you do content translation via gettext catalogs.
 77  # Usually you set "language" from the command line for these cases.
 78  language = "en"
 79  
 80  # There are two options for replacing |today|: either, you set today to some
 81  # non-false value, then it is used:
 82  # today = ''
 83  # Else, today_fmt is used as the format for a strftime call.
 84  # today_fmt = '%B %d, %Y'
 85  
 86  # List of patterns, relative to source directory, that match files and
 87  # directories to ignore when looking for source files.
 88  exclude_patterns = ["_build"]
 89  
 90  # The reST default role (used for this markup: `text`) to use for all
 91  # documents.
 92  # default_role = None
 93  
 94  # If true, '()' will be appended to :func: etc. cross-reference text.
 95  # add_function_parentheses = True
 96  
 97  # If true, the current module name will be prepended to all description
 98  # unit titles (such as .. function::).
 99  # add_module_names = True
100  
101  # If true, sectionauthor and moduleauthor directives will be shown in the
102  # output. They are ignored by default.
103  # show_authors = False
104  
105  # The name of the Pygments (syntax highlighting) style to use.
106  pygments_style = "sphinx"
107  
108  # A list of ignored prefixes for module index sorting.
109  # modindex_common_prefix = []
110  
111  # If true, keep warnings as "system message" paragraphs in the built documents.
112  # keep_warnings = False
113  
114  # If true, `todo` and `todoList` produce output, else they produce nothing.
115  todo_include_todos = False
116  
117  
118  # -- Options for HTML output ----------------------------------------------
119  
120  # The theme to use for HTML and HTML Help pages.  See the documentation for
121  # a list of builtin themes.
122  html_theme = "sphinx_rtd_theme"
123  
124  # Theme options are theme-specific and customize the look and feel of a theme
125  # further.  For a list of options available for each theme, see the
126  # documentation.
127  # html_theme_options = {}
128  
129  # Add any paths that contain custom themes here, relative to this directory.
130  # html_theme_path = []
131  
132  # The name for this set of Sphinx documents.  If None, it defaults to
133  # "<project> v<release> documentation".
134  # html_title = None
135  
136  # A shorter title for the navigation bar.  Default is the same as html_title.
137  # html_short_title = None
138  
139  # The name of an image file (relative to this directory) to place at the top
140  # of the sidebar.
141  # html_logo = None
142  
143  # The name of an image file (within the static path) to use as favicon of the
144  # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
145  # pixels large.
146  # html_favicon = None
147  
148  # Add any paths that contain custom static files (such as style sheets) here,
149  # relative to this directory. They are copied after the builtin static files,
150  # so a file named "default.css" will overwrite the builtin "default.css".
151  # html_static_path = ["_static"]
152  
153  # Add any extra paths that contain custom files (such as robots.txt or
154  # .htaccess) here, relative to this directory. These files are copied
155  # directly to the root of the documentation.
156  # html_extra_path = []
157  
158  # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
159  # using the given strftime format.
160  # html_last_updated_fmt = '%b %d, %Y'
161  
162  # If true, SmartyPants will be used to convert quotes and dashes to
163  # typographically correct entities.
164  # html_use_smartypants = True
165  
166  # Custom sidebar templates, maps document names to template names.
167  # html_sidebars = {}
168  
169  # Additional templates that should be rendered to pages, maps page names to
170  # template names.
171  # html_additional_pages = {}
172  
173  # If false, no module index is generated.
174  # html_domain_indices = True
175  
176  # If false, no index is generated.
177  # html_use_index = True
178  
179  # If true, the index is split into individual pages for each letter.
180  # html_split_index = False
181  
182  # If true, links to the reST sources are added to the pages.
183  # html_show_sourcelink = True
184  
185  # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
186  # html_show_sphinx = True
187  
188  # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
189  # html_show_copyright = True
190  
191  # If true, an OpenSearch description file will be output, and all pages will
192  # contain a <link> tag referring to it.  The value of this option must be the
193  # base URL from which the finished HTML is served.
194  # html_use_opensearch = ''
195  
196  # This is the file name suffix for HTML files (e.g. ".xhtml").
197  # html_file_suffix = None
198  
199  # Language to be used for generating the HTML full-text search index.
200  # Sphinx supports the following languages:
201  #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
202  #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
203  # html_search_language = 'en'
204  
205  # A dictionary with options for the search language support, empty by default.
206  # Now only 'ja' uses this config value
207  # html_search_options = {'type': 'default'}
208  
209  # The name of a javascript file (relative to the configuration directory) that
210  # implements a search results scorer. If empty, the default will be used.
211  # html_search_scorer = 'scorer.js'
212  
213  # Output file base name for HTML help builder.
214  htmlhelp_basename = "Adafruit_Blinka_Raspberry_Pi5_rp1pio_doc"